Share via

Microsoft.SqlVirtualMachine sqlVirtualMachines 2017-03-01-preview

  • Article

Bicep resource definition

The sqlVirtualMachines resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SqlVirtualMachine/sqlVirtualMachines resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.SqlVirtualMachine/sqlVirtualMachines@2017-03-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    autoBackupSettings: {
      backupScheduleType: 'string'
      backupSystemDbs: bool
      enable: bool
      enableEncryption: bool
      fullBackupFrequency: 'string'
      fullBackupStartTime: int
      fullBackupWindowHours: int
      logBackupFrequency: int
      password: 'string'
      retentionPeriod: int
      storageAccessKey: 'string'
      storageAccountUrl: 'string'
    }
    autoPatchingSettings: {
      dayOfWeek: 'string'
      enable: bool
      maintenanceWindowDuration: int
      maintenanceWindowStartingHour: int
    }
    keyVaultCredentialSettings: {
      azureKeyVaultUrl: 'string'
      credentialName: 'string'
      enable: bool
      servicePrincipalName: 'string'
      servicePrincipalSecret: 'string'
    }
    serverConfigurationsManagementSettings: {
      additionalFeaturesServerConfigurations: {
        isRServicesEnabled: bool
      }
      sqlConnectivityUpdateSettings: {
        connectivityType: 'string'
        port: int
        sqlAuthUpdatePassword: 'string'
        sqlAuthUpdateUserName: 'string'
      }
      sqlStorageUpdateSettings: {
        diskConfigurationType: 'string'
        diskCount: int
        startingDeviceId: int
      }
      sqlWorkloadTypeUpdateSettings: {
        sqlWorkloadType: 'string'
      }
    }
    sqlImageOffer: 'string'
    sqlImageSku: 'string'
    sqlManagement: 'string'
    sqlServerLicenseType: 'string'
    sqlVirtualMachineGroupResourceId: 'string'
    storageConfigurationSettings: {
      diskConfigurationType: 'string'
      sqlDataSettings: {
        defaultFilePath: 'string'
        luns: [
          int
        ]
      }
      sqlLogSettings: {
        defaultFilePath: 'string'
        luns: [
          int
        ]
      }
      sqlTempDbSettings: {
        defaultFilePath: 'string'
        luns: [
          int
        ]
      }
      storageWorkloadType: 'string'
    }
    virtualMachineResourceId: 'string'
    wsfcDomainCredentials: {
      clusterBootstrapAccountPassword: 'string'
      clusterOperatorAccountPassword: 'string'
      sqlServiceAccountPassword: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AdditionalFeaturesServerConfigurations

Name Description Value
isRServicesEnabled Enable or disable R services (SQL 2016 onwards). bool

AutoBackupSettings

Name Description Value
backupScheduleType Backup schedule type. 'Automated'
'Manual'
backupSystemDbs Include or exclude system databases from auto backup. bool
enable Enable or disable autobackup on SQL virtual machine. bool
enableEncryption Enable or disable encryption for backup on SQL virtual machine. bool
fullBackupFrequency Frequency of full backups. In both cases, full backups begin during the next scheduled time window. 'Daily'
'Weekly'
fullBackupStartTime Start time of a given day during which full backups can take place. 0-23 hours. int
fullBackupWindowHours Duration of the time window of a given day during which full backups can take place. 1-23 hours. int
logBackupFrequency Frequency of log backups. 5-60 minutes. int
password Password for encryption on backup. string
retentionPeriod Retention period of backup: 1-30 days. int
storageAccessKey Storage account key where backup will be taken to. string
storageAccountUrl Storage account url where backup will be taken to. string

AutoPatchingSettings

Name Description Value
dayOfWeek Day of week to apply the patch on. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
enable Enable or disable autopatching on SQL virtual machine. bool
maintenanceWindowDuration Duration of patching. int
maintenanceWindowStartingHour Hour of the day when patching is initiated. Local VM time. int

KeyVaultCredentialSettings

Name Description Value
azureKeyVaultUrl Azure Key Vault url. string
credentialName Credential name. string
enable Enable or disable key vault credential setting. bool
servicePrincipalName Service principal name to access key vault. string
servicePrincipalSecret Service principal name secret to access key vault. string

Microsoft.SqlVirtualMachine/sqlVirtualMachines

Name Description Value
identity Azure Active Directory identity of the server. ResourceIdentity
location Resource location. string (required)
name The resource name string (required)
properties Resource properties. SqlVirtualMachineProperties
tags Resource tags. TrackedResourceTags

ResourceIdentity

Name Description Value
type The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. 'SystemAssigned'

ServerConfigurationsManagementSettings

Name Description Value
additionalFeaturesServerConfigurations Additional SQL feature settings. AdditionalFeaturesServerConfigurations
sqlConnectivityUpdateSettings SQL connectivity type settings. SqlConnectivityUpdateSettings
sqlStorageUpdateSettings SQL storage update settings. SqlStorageUpdateSettings
sqlWorkloadTypeUpdateSettings SQL workload type settings. SqlWorkloadTypeUpdateSettings

SqlConnectivityUpdateSettings

Name Description Value
connectivityType SQL Server connectivity option. 'LOCAL'
'PRIVATE'
'PUBLIC'
port SQL Server port. int
sqlAuthUpdatePassword SQL Server sysadmin login password. string
sqlAuthUpdateUserName SQL Server sysadmin login to create. string

SQLStorageSettings

Name Description Value
defaultFilePath SQL Server default file path string
luns Logical Unit Numbers for the disks. int[]

SqlStorageUpdateSettings

Name Description Value
diskConfigurationType Disk configuration to apply to SQL Server. 'ADD'
'EXTEND'
'NEW'
diskCount Virtual machine disk count. int
startingDeviceId Device id of the first disk to be updated. int

SqlVirtualMachineProperties

Name Description Value
autoBackupSettings Auto backup settings for SQL Server. AutoBackupSettings
autoPatchingSettings Auto patching settings for applying critical security updates to SQL virtual machine. AutoPatchingSettings
keyVaultCredentialSettings Key vault credential settings. KeyVaultCredentialSettings
serverConfigurationsManagementSettings SQL Server configuration management settings. ServerConfigurationsManagementSettings
sqlImageOffer SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. string
sqlImageSku SQL Server edition type. 'Developer'
'Enterprise'
'Express'
'Standard'
'Web'
sqlManagement SQL Server Management type. 'Full'
'LightWeight'
'NoAgent'
sqlServerLicenseType SQL Server license type. 'AHUB'
'DR'
'PAYG'
sqlVirtualMachineGroupResourceId ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. string
storageConfigurationSettings Storage Configuration Settings. StorageConfigurationSettings
virtualMachineResourceId ARM Resource id of underlying virtual machine created from SQL marketplace image. string
wsfcDomainCredentials Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. WsfcDomainCredentials

SqlWorkloadTypeUpdateSettings

Name Description Value
sqlWorkloadType SQL Server workload type. 'DW'
'GENERAL'
'OLTP'

StorageConfigurationSettings

Name Description Value
diskConfigurationType Disk configuration to apply to SQL Server. 'ADD'
'EXTEND'
'NEW'
sqlDataSettings SQL Server Data Storage Settings. SQLStorageSettings
sqlLogSettings SQL Server Log Storage Settings. SQLStorageSettings
sqlTempDbSettings SQL Server TempDb Storage Settings. SQLStorageSettings
storageWorkloadType Storage workload type. 'DW'
'GENERAL'
'OLTP'

TrackedResourceTags

Name Description Value

WsfcDomainCredentials

Name Description Value
clusterBootstrapAccountPassword Cluster bootstrap account password. string
clusterOperatorAccountPassword Cluster operator account password. string
sqlServiceAccountPassword SQL service account password. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy SQL Always ON setup with existing SQL Virtual Machines

Deploy to Azure		 Deploy SQL Always ON setup with existing SQL Virtual Machines. The virtual machines should already be joined to an existing domain and must be running enterprise version of SQL Server.
SQL Server VM with performance optimized storage settings

Deploy to Azure		 Create a SQL Server Virtual Machine with performance optimized storage settings on PremiumSSD
SQL VM Performance Optimized Storage Settings on UltraSSD

Deploy to Azure		 Create a SQL Server Virtual Machine with performance optimized storage settings, using UltraSSD for SQL Log files

ARM template resource definition

The sqlVirtualMachines resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SqlVirtualMachine/sqlVirtualMachines resource, add the following JSON to your template.

{
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "apiVersion": "2017-03-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "autoBackupSettings": {
      "backupScheduleType": "string",
      "backupSystemDbs": "bool",
      "enable": "bool",
      "enableEncryption": "bool",
      "fullBackupFrequency": "string",
      "fullBackupStartTime": "int",
      "fullBackupWindowHours": "int",
      "logBackupFrequency": "int",
      "password": "string",
      "retentionPeriod": "int",
      "storageAccessKey": "string",
      "storageAccountUrl": "string"
    },
    "autoPatchingSettings": {
      "dayOfWeek": "string",
      "enable": "bool",
      "maintenanceWindowDuration": "int",
      "maintenanceWindowStartingHour": "int"
    },
    "keyVaultCredentialSettings": {
      "azureKeyVaultUrl": "string",
      "credentialName": "string",
      "enable": "bool",
      "servicePrincipalName": "string",
      "servicePrincipalSecret": "string"
    },
    "serverConfigurationsManagementSettings": {
      "additionalFeaturesServerConfigurations": {
        "isRServicesEnabled": "bool"
      },
      "sqlConnectivityUpdateSettings": {
        "connectivityType": "string",
        "port": "int",
        "sqlAuthUpdatePassword": "string",
        "sqlAuthUpdateUserName": "string"
      },
      "sqlStorageUpdateSettings": {
        "diskConfigurationType": "string",
        "diskCount": "int",
        "startingDeviceId": "int"
      },
      "sqlWorkloadTypeUpdateSettings": {
        "sqlWorkloadType": "string"
      }
    },
    "sqlImageOffer": "string",
    "sqlImageSku": "string",
    "sqlManagement": "string",
    "sqlServerLicenseType": "string",
    "sqlVirtualMachineGroupResourceId": "string",
    "storageConfigurationSettings": {
      "diskConfigurationType": "string",
      "sqlDataSettings": {
        "defaultFilePath": "string",
        "luns": [ "int" ]
      },
      "sqlLogSettings": {
        "defaultFilePath": "string",
        "luns": [ "int" ]
      },
      "sqlTempDbSettings": {
        "defaultFilePath": "string",
        "luns": [ "int" ]
      },
      "storageWorkloadType": "string"
    },
    "virtualMachineResourceId": "string",
    "wsfcDomainCredentials": {
      "clusterBootstrapAccountPassword": "string",
      "clusterOperatorAccountPassword": "string",
      "sqlServiceAccountPassword": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AdditionalFeaturesServerConfigurations

Name Description Value
isRServicesEnabled Enable or disable R services (SQL 2016 onwards). bool

AutoBackupSettings

Name Description Value
backupScheduleType Backup schedule type. 'Automated'
'Manual'
backupSystemDbs Include or exclude system databases from auto backup. bool
enable Enable or disable autobackup on SQL virtual machine. bool
enableEncryption Enable or disable encryption for backup on SQL virtual machine. bool
fullBackupFrequency Frequency of full backups. In both cases, full backups begin during the next scheduled time window. 'Daily'
'Weekly'
fullBackupStartTime Start time of a given day during which full backups can take place. 0-23 hours. int
fullBackupWindowHours Duration of the time window of a given day during which full backups can take place. 1-23 hours. int
logBackupFrequency Frequency of log backups. 5-60 minutes. int
password Password for encryption on backup. string
retentionPeriod Retention period of backup: 1-30 days. int
storageAccessKey Storage account key where backup will be taken to. string
storageAccountUrl Storage account url where backup will be taken to. string

AutoPatchingSettings

Name Description Value
dayOfWeek Day of week to apply the patch on. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
enable Enable or disable autopatching on SQL virtual machine. bool
maintenanceWindowDuration Duration of patching. int
maintenanceWindowStartingHour Hour of the day when patching is initiated. Local VM time. int

KeyVaultCredentialSettings

Name Description Value
azureKeyVaultUrl Azure Key Vault url. string
credentialName Credential name. string
enable Enable or disable key vault credential setting. bool
servicePrincipalName Service principal name to access key vault. string
servicePrincipalSecret Service principal name secret to access key vault. string

Microsoft.SqlVirtualMachine/sqlVirtualMachines

Name Description Value
identity Azure Active Directory identity of the server. ResourceIdentity
location Resource location. string (required)
name The resource name string (required)
properties Resource properties. SqlVirtualMachineProperties
tags Resource tags. TrackedResourceTags

ResourceIdentity

Name Description Value
type The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. 'SystemAssigned'

ServerConfigurationsManagementSettings

Name Description Value
additionalFeaturesServerConfigurations Additional SQL feature settings. AdditionalFeaturesServerConfigurations
sqlConnectivityUpdateSettings SQL connectivity type settings. SqlConnectivityUpdateSettings
sqlStorageUpdateSettings SQL storage update settings. SqlStorageUpdateSettings
sqlWorkloadTypeUpdateSettings SQL workload type settings. SqlWorkloadTypeUpdateSettings

SqlConnectivityUpdateSettings

Name Description Value
connectivityType SQL Server connectivity option. 'LOCAL'
'PRIVATE'
'PUBLIC'
port SQL Server port. int
sqlAuthUpdatePassword SQL Server sysadmin login password. string
sqlAuthUpdateUserName SQL Server sysadmin login to create. string

SQLStorageSettings

Name Description Value
defaultFilePath SQL Server default file path string
luns Logical Unit Numbers for the disks. int[]

SqlStorageUpdateSettings

Name Description Value
diskConfigurationType Disk configuration to apply to SQL Server. 'ADD'
'EXTEND'
'NEW'
diskCount Virtual machine disk count. int
startingDeviceId Device id of the first disk to be updated. int

SqlVirtualMachineProperties

Name Description Value
autoBackupSettings Auto backup settings for SQL Server. AutoBackupSettings
autoPatchingSettings Auto patching settings for applying critical security updates to SQL virtual machine. AutoPatchingSettings
keyVaultCredentialSettings Key vault credential settings. KeyVaultCredentialSettings
serverConfigurationsManagementSettings SQL Server configuration management settings. ServerConfigurationsManagementSettings
sqlImageOffer SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. string
sqlImageSku SQL Server edition type. 'Developer'
'Enterprise'
'Express'
'Standard'
'Web'
sqlManagement SQL Server Management type. 'Full'
'LightWeight'
'NoAgent'
sqlServerLicenseType SQL Server license type. 'AHUB'
'DR'
'PAYG'
sqlVirtualMachineGroupResourceId ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. string
storageConfigurationSettings Storage Configuration Settings. StorageConfigurationSettings
virtualMachineResourceId ARM Resource id of underlying virtual machine created from SQL marketplace image. string
wsfcDomainCredentials Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. WsfcDomainCredentials

SqlWorkloadTypeUpdateSettings

Name Description Value
sqlWorkloadType SQL Server workload type. 'DW'
'GENERAL'
'OLTP'

StorageConfigurationSettings

Name Description Value
diskConfigurationType Disk configuration to apply to SQL Server. 'ADD'
'EXTEND'
'NEW'
sqlDataSettings SQL Server Data Storage Settings. SQLStorageSettings
sqlLogSettings SQL Server Log Storage Settings. SQLStorageSettings
sqlTempDbSettings SQL Server TempDb Storage Settings. SQLStorageSettings
storageWorkloadType Storage workload type. 'DW'
'GENERAL'
'OLTP'

TrackedResourceTags

Name Description Value

WsfcDomainCredentials

Name Description Value
clusterBootstrapAccountPassword Cluster bootstrap account password. string
clusterOperatorAccountPassword Cluster operator account password. string
sqlServiceAccountPassword SQL service account password. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy SQL Always ON setup with existing SQL Virtual Machines

Deploy to Azure		 Deploy SQL Always ON setup with existing SQL Virtual Machines. The virtual machines should already be joined to an existing domain and must be running enterprise version of SQL Server.
SQL Server VM with performance optimized storage settings

Deploy to Azure		 Create a SQL Server Virtual Machine with performance optimized storage settings on PremiumSSD
SQL VM Performance Optimized Storage Settings on UltraSSD

Deploy to Azure		 Create a SQL Server Virtual Machine with performance optimized storage settings, using UltraSSD for SQL Log files

Terraform (AzAPI provider) resource definition

The sqlVirtualMachines resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SqlVirtualMachine/sqlVirtualMachines resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" = {
  type = "Microsoft.SqlVirtualMachine/sqlVirtualMachines@2017-03-01-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  body = jsonencode({
    properties = {
      autoBackupSettings = {
        backupScheduleType = "string"
        backupSystemDbs = bool
        enable = bool
        enableEncryption = bool
        fullBackupFrequency = "string"
        fullBackupStartTime = int
        fullBackupWindowHours = int
        logBackupFrequency = int
        password = "string"
        retentionPeriod = int
        storageAccessKey = "string"
        storageAccountUrl = "string"
      }
      autoPatchingSettings = {
        dayOfWeek = "string"
        enable = bool
        maintenanceWindowDuration = int
        maintenanceWindowStartingHour = int
      }
      keyVaultCredentialSettings = {
        azureKeyVaultUrl = "string"
        credentialName = "string"
        enable = bool
        servicePrincipalName = "string"
        servicePrincipalSecret = "string"
      }
      serverConfigurationsManagementSettings = {
        additionalFeaturesServerConfigurations = {
          isRServicesEnabled = bool
        }
        sqlConnectivityUpdateSettings = {
          connectivityType = "string"
          port = int
          sqlAuthUpdatePassword = "string"
          sqlAuthUpdateUserName = "string"
        }
        sqlStorageUpdateSettings = {
          diskConfigurationType = "string"
          diskCount = int
          startingDeviceId = int
        }
        sqlWorkloadTypeUpdateSettings = {
          sqlWorkloadType = "string"
        }
      }
      sqlImageOffer = "string"
      sqlImageSku = "string"
      sqlManagement = "string"
      sqlServerLicenseType = "string"
      sqlVirtualMachineGroupResourceId = "string"
      storageConfigurationSettings = {
        diskConfigurationType = "string"
        sqlDataSettings = {
          defaultFilePath = "string"
          luns = [
            int
          ]
        }
        sqlLogSettings = {
          defaultFilePath = "string"
          luns = [
            int
          ]
        }
        sqlTempDbSettings = {
          defaultFilePath = "string"
          luns = [
            int
          ]
        }
        storageWorkloadType = "string"
      }
      virtualMachineResourceId = "string"
      wsfcDomainCredentials = {
        clusterBootstrapAccountPassword = "string"
        clusterOperatorAccountPassword = "string"
        sqlServiceAccountPassword = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

AdditionalFeaturesServerConfigurations

Name Description Value
isRServicesEnabled Enable or disable R services (SQL 2016 onwards). bool

AutoBackupSettings

Name Description Value
backupScheduleType Backup schedule type. 'Automated'
'Manual'
backupSystemDbs Include or exclude system databases from auto backup. bool
enable Enable or disable autobackup on SQL virtual machine. bool
enableEncryption Enable or disable encryption for backup on SQL virtual machine. bool
fullBackupFrequency Frequency of full backups. In both cases, full backups begin during the next scheduled time window. 'Daily'
'Weekly'
fullBackupStartTime Start time of a given day during which full backups can take place. 0-23 hours. int
fullBackupWindowHours Duration of the time window of a given day during which full backups can take place. 1-23 hours. int
logBackupFrequency Frequency of log backups. 5-60 minutes. int
password Password for encryption on backup. string
retentionPeriod Retention period of backup: 1-30 days. int
storageAccessKey Storage account key where backup will be taken to. string
storageAccountUrl Storage account url where backup will be taken to. string

AutoPatchingSettings

Name Description Value
dayOfWeek Day of week to apply the patch on. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
enable Enable or disable autopatching on SQL virtual machine. bool
maintenanceWindowDuration Duration of patching. int
maintenanceWindowStartingHour Hour of the day when patching is initiated. Local VM time. int

KeyVaultCredentialSettings

Name Description Value
azureKeyVaultUrl Azure Key Vault url. string
credentialName Credential name. string
enable Enable or disable key vault credential setting. bool
servicePrincipalName Service principal name to access key vault. string
servicePrincipalSecret Service principal name secret to access key vault. string

Microsoft.SqlVirtualMachine/sqlVirtualMachines

Name Description Value
identity Azure Active Directory identity of the server. ResourceIdentity
location Resource location. string (required)
name The resource name string (required)
properties Resource properties. SqlVirtualMachineProperties
tags Resource tags. TrackedResourceTags

ResourceIdentity

Name Description Value
type The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. 'SystemAssigned'

ServerConfigurationsManagementSettings

Name Description Value
additionalFeaturesServerConfigurations Additional SQL feature settings. AdditionalFeaturesServerConfigurations
sqlConnectivityUpdateSettings SQL connectivity type settings. SqlConnectivityUpdateSettings
sqlStorageUpdateSettings SQL storage update settings. SqlStorageUpdateSettings
sqlWorkloadTypeUpdateSettings SQL workload type settings. SqlWorkloadTypeUpdateSettings

SqlConnectivityUpdateSettings

Name Description Value
connectivityType SQL Server connectivity option. 'LOCAL'
'PRIVATE'
'PUBLIC'
port SQL Server port. int
sqlAuthUpdatePassword SQL Server sysadmin login password. string
sqlAuthUpdateUserName SQL Server sysadmin login to create. string

SQLStorageSettings

Name Description Value
defaultFilePath SQL Server default file path string
luns Logical Unit Numbers for the disks. int[]

SqlStorageUpdateSettings

Name Description Value
diskConfigurationType Disk configuration to apply to SQL Server. 'ADD'
'EXTEND'
'NEW'
diskCount Virtual machine disk count. int
startingDeviceId Device id of the first disk to be updated. int

SqlVirtualMachineProperties

Name Description Value
autoBackupSettings Auto backup settings for SQL Server. AutoBackupSettings
autoPatchingSettings Auto patching settings for applying critical security updates to SQL virtual machine. AutoPatchingSettings
keyVaultCredentialSettings Key vault credential settings. KeyVaultCredentialSettings
serverConfigurationsManagementSettings SQL Server configuration management settings. ServerConfigurationsManagementSettings
sqlImageOffer SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. string
sqlImageSku SQL Server edition type. 'Developer'
'Enterprise'
'Express'
'Standard'
'Web'
sqlManagement SQL Server Management type. 'Full'
'LightWeight'
'NoAgent'
sqlServerLicenseType SQL Server license type. 'AHUB'
'DR'
'PAYG'
sqlVirtualMachineGroupResourceId ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. string
storageConfigurationSettings Storage Configuration Settings. StorageConfigurationSettings
virtualMachineResourceId ARM Resource id of underlying virtual machine created from SQL marketplace image. string
wsfcDomainCredentials Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. WsfcDomainCredentials

SqlWorkloadTypeUpdateSettings

Name Description Value
sqlWorkloadType SQL Server workload type. 'DW'
'GENERAL'
'OLTP'

StorageConfigurationSettings

Name Description Value
diskConfigurationType Disk configuration to apply to SQL Server. 'ADD'
'EXTEND'
'NEW'
sqlDataSettings SQL Server Data Storage Settings. SQLStorageSettings
sqlLogSettings SQL Server Log Storage Settings. SQLStorageSettings
sqlTempDbSettings SQL Server TempDb Storage Settings. SQLStorageSettings
storageWorkloadType Storage workload type. 'DW'
'GENERAL'
'OLTP'

TrackedResourceTags

Name Description Value

WsfcDomainCredentials

Name Description Value
clusterBootstrapAccountPassword Cluster bootstrap account password. string
clusterOperatorAccountPassword Cluster operator account password. string
sqlServiceAccountPassword SQL service account password. string