Share via

SqlVirtualMachine interface

  • Reference
Package:
@azure/arm-sqlvirtualmachine

A SQL virtual machine.

Extends
TrackedResource

Properties

autoBackupSettings

Auto backup settings for SQL Server.
autoPatchingSettings

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

Azure Active Directory identity of the server.
keyVaultCredentialSettings

Key vault credential settings.
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. Possible values include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web'
sqlManagement

SQL Server Management type. Possible values include: 'Full', 'LightWeight', 'NoAgent'
sqlServerLicenseType

SQL Server license type. Possible values include: 'PAYG', 'AHUB', 'DR'
sqlVirtualMachineGroupResourceId

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

Storage Configuration Settings.
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.

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

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

identity

Azure Active Directory identity of the server.

identity?: ResourceIdentity

Property Value

ResourceIdentity

keyVaultCredentialSettings

Key vault credential settings.

keyVaultCredentialSettings?: KeyVaultCredentialSettings

Property Value

KeyVaultCredentialSettings

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. Possible values include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web'

sqlImageSku?: SqlImageSku

Property Value

SqlImageSku

sqlManagement

SQL Server Management type. Possible values include: 'Full', 'LightWeight', 'NoAgent'

sqlManagement?: SqlManagementMode

Property Value

SqlManagementMode

sqlServerLicenseType

SQL Server license type. Possible values include: 'PAYG', 'AHUB', 'DR'

sqlServerLicenseType?: SqlServerLicenseType

Property Value

SqlServerLicenseType

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

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

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