SqlVirtualMachineProperties interface

Package:

@azure/arm-sqlvirtualmachine

The SQL virtual machine properties.

Properties

additionalVmPatch	Additional VM Patching solution enabled on the Virtual Machine
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.
keyVaultCredentialSettings	Key vault credential settings.
leastPrivilegeMode	SQL IaaS Agent least privilege mode.
osType	Operating System of the current SQL Virtual Machine.
provisioningState	Provisioning state to track the async operation status.
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. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it.
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.
troubleshootingStatus	Troubleshooting status
virtualMachineIdentitySettings	Virtual Machine Identity details used for Sql IaaS extension configurations.
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.

Property Details

additionalVmPatch

Additional VM Patching solution enabled on the Virtual Machine

additionalVmPatch?: string

Property Value

string

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

keyVaultCredentialSettings

Key vault credential settings.

keyVaultCredentialSettings?: KeyVaultCredentialSettings

Property Value

KeyVaultCredentialSettings

leastPrivilegeMode

SQL IaaS Agent least privilege mode.

leastPrivilegeMode?: string

Property Value

string

osType

Operating System of the current SQL Virtual Machine.

osType?: OsType

Property Value

OsType

provisioningState

Provisioning state to track the async operation status.

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. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it.

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

troubleshootingStatus

Troubleshooting status

troubleshootingStatus?: TroubleshootingStatus

Property Value

TroubleshootingStatus

virtualMachineIdentitySettings

Virtual Machine Identity details used for Sql IaaS extension configurations.

virtualMachineIdentitySettings?: VirtualMachineIdentity

Property Value

VirtualMachineIdentity

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