Share via

SqlVirtualMachine interface

Package:
@azure/arm-sqlvirtualmachine

A SQL virtual machine.

Extends
TrackedResource

Properties

assessmentSettings

SQL best practices Assessment Settings.
autoBackupSettings

Auto backup settings for SQL Server.
autoPatchingSettings

Auto patching settings for applying critical security updates to SQL virtual machine.
enableAutomaticUpgrade

Enable automatic upgrade of Sql IaaS extension Agent.
identity

Azure Active Directory identity of the server.
keyVaultCredentialSettings

Key vault credential settings.
leastPrivilegeMode

SQL IaaS Agent least privilege mode.
provisioningState

Provisioning state to track the async operation status. NOTE: This property will not be serialized. It can only be populated by the server.
serverConfigurationsManagementSettings

SQL Server configuration management settings.
sqlImageOffer

SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku

SQL Server edition type.
sqlManagement

SQL Server Management type.
sqlServerLicenseType

SQL Server license type.
sqlVirtualMachineGroupResourceId

ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.
storageConfigurationSettings

Storage Configuration Settings.
systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
troubleshootingStatus

Troubleshooting status NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachineResourceId

ARM Resource id of underlying virtual machine created from SQL marketplace image.
wsfcDomainCredentials

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
wsfcStaticIp

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

assessmentSettings

SQL best practices Assessment Settings.

assessmentSettings?: AssessmentSettings

Property Value

AssessmentSettings

autoBackupSettings

Auto backup settings for SQL Server.

autoBackupSettings?: AutoBackupSettings

Property Value

AutoBackupSettings

autoPatchingSettings

Auto patching settings for applying critical security updates to SQL virtual machine.

autoPatchingSettings?: AutoPatchingSettings

Property Value

AutoPatchingSettings

enableAutomaticUpgrade

Enable automatic upgrade of Sql IaaS extension Agent.

enableAutomaticUpgrade?: boolean

Property Value

boolean

identity

Azure Active Directory identity of the server.

identity?: ResourceIdentity

Property Value

ResourceIdentity

keyVaultCredentialSettings

Key vault credential settings.

keyVaultCredentialSettings?: KeyVaultCredentialSettings

Property Value

KeyVaultCredentialSettings

leastPrivilegeMode

SQL IaaS Agent least privilege mode.

leastPrivilegeMode?: string

Property Value

string

provisioningState

Provisioning state to track the async operation status. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

serverConfigurationsManagementSettings

SQL Server configuration management settings.

serverConfigurationsManagementSettings?: ServerConfigurationsManagementSettings

Property Value

ServerConfigurationsManagementSettings

sqlImageOffer

SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.

sqlImageOffer?: string

Property Value

string

sqlImageSku

SQL Server edition type.

sqlImageSku?: string

Property Value

string

sqlManagement

SQL Server Management type.

sqlManagement?: string

Property Value

string

sqlServerLicenseType

SQL Server license type.

sqlServerLicenseType?: string

Property Value

string

sqlVirtualMachineGroupResourceId

ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.

sqlVirtualMachineGroupResourceId?: string

Property Value

string

storageConfigurationSettings

Storage Configuration Settings.

storageConfigurationSettings?: StorageConfigurationSettings

Property Value

StorageConfigurationSettings

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

troubleshootingStatus

Troubleshooting status NOTE: This property will not be serialized. It can only be populated by the server.

troubleshootingStatus?: TroubleshootingStatus

Property Value

TroubleshootingStatus

virtualMachineResourceId

ARM Resource id of underlying virtual machine created from SQL marketplace image.

virtualMachineResourceId?: string

Property Value

string

wsfcDomainCredentials

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

wsfcDomainCredentials?: WsfcDomainCredentials

Property Value

WsfcDomainCredentials

wsfcStaticIp

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

wsfcStaticIp?: string

Property Value

string

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Resource location.

location: string

Property Value

string

Inherited From TrackedResource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type