Microsoft.SqlVirtualMachine sqlVirtualMachineGroups
Bicep resource definition
The sqlVirtualMachineGroups resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2022-08-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
sqlImageOffer: 'string'
sqlImageSku: 'string'
wsfcDomainProfile: {
clusterBootstrapAccount: 'string'
clusterOperatorAccount: 'string'
clusterSubnetType: 'string'
domainFqdn: 'string'
fileShareWitnessPath: 'string'
ouPath: 'string'
sqlServiceAccount: 'string'
storageAccountPrimaryKey: 'string'
storageAccountUrl: 'string'
}
}
}
Property values
sqlVirtualMachineGroups
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Resource properties. | SqlVirtualMachineGroupProperties |
SqlVirtualMachineGroupProperties
| Name | Description | Value |
|---|---|---|
| sqlImageOffer | SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. | string |
| sqlImageSku | SQL image sku. | 'Developer' 'Enterprise' |
| wsfcDomainProfile | Cluster Active Directory domain profile. | WsfcDomainProfile |
WsfcDomainProfile
| Name | Description | Value |
|---|---|---|
| clusterBootstrapAccount | Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). | string |
| clusterOperatorAccount | Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. | string |
| clusterSubnetType | Cluster subnet type. | 'MultiSubnet' 'SingleSubnet' |
| domainFqdn | Fully qualified name of the domain. | string |
| fileShareWitnessPath | Optional path for fileshare witness. | string |
| ouPath | Organizational Unit path in which the nodes and cluster will be present. | string |
| sqlServiceAccount | Account name under which SQL service will run on all participating SQL virtual machines in the cluster. | string |
| storageAccountPrimaryKey | Primary key of the witness storage account. | string |
| storageAccountUrl | Fully qualified ARM resource id of the witness storage account. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy SQL Always ON setup with existing SQL Virtual Machines |
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. |
ARM template resource definition
The sqlVirtualMachineGroups resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups resource, add the following JSON to your template.
{
"type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups",
"apiVersion": "2022-08-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"sqlImageOffer": "string",
"sqlImageSku": "string",
"wsfcDomainProfile": {
"clusterBootstrapAccount": "string",
"clusterOperatorAccount": "string",
"clusterSubnetType": "string",
"domainFqdn": "string",
"fileShareWitnessPath": "string",
"ouPath": "string",
"sqlServiceAccount": "string",
"storageAccountPrimaryKey": "string",
"storageAccountUrl": "string"
}
}
}
Property values
sqlVirtualMachineGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups' |
| apiVersion | The resource api version | '2022-08-01-preview' |
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Resource properties. | SqlVirtualMachineGroupProperties |
SqlVirtualMachineGroupProperties
| Name | Description | Value |
|---|---|---|
| sqlImageOffer | SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. | string |
| sqlImageSku | SQL image sku. | 'Developer' 'Enterprise' |
| wsfcDomainProfile | Cluster Active Directory domain profile. | WsfcDomainProfile |
WsfcDomainProfile
| Name | Description | Value |
|---|---|---|
| clusterBootstrapAccount | Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). | string |
| clusterOperatorAccount | Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. | string |
| clusterSubnetType | Cluster subnet type. | 'MultiSubnet' 'SingleSubnet' |
| domainFqdn | Fully qualified name of the domain. | string |
| fileShareWitnessPath | Optional path for fileshare witness. | string |
| ouPath | Organizational Unit path in which the nodes and cluster will be present. | string |
| sqlServiceAccount | Account name under which SQL service will run on all participating SQL virtual machines in the cluster. | string |
| storageAccountPrimaryKey | Primary key of the witness storage account. | string |
| storageAccountUrl | Fully qualified ARM resource id of the witness storage account. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Deploy SQL Always ON setup with existing SQL Virtual Machines |
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. |
Terraform (AzAPI provider) resource definition
The sqlVirtualMachineGroups resource type can be deployed to:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2022-08-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
sqlImageOffer = "string"
sqlImageSku = "string"
wsfcDomainProfile = {
clusterBootstrapAccount = "string"
clusterOperatorAccount = "string"
clusterSubnetType = "string"
domainFqdn = "string"
fileShareWitnessPath = "string"
ouPath = "string"
sqlServiceAccount = "string"
storageAccountPrimaryKey = "string"
storageAccountUrl = "string"
}
}
})
}
Property values
sqlVirtualMachineGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2022-08-01-preview" |
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| properties | Resource properties. | SqlVirtualMachineGroupProperties |
SqlVirtualMachineGroupProperties
| Name | Description | Value |
|---|---|---|
| sqlImageOffer | SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. | string |
| sqlImageSku | SQL image sku. | "Developer" "Enterprise" |
| wsfcDomainProfile | Cluster Active Directory domain profile. | WsfcDomainProfile |
WsfcDomainProfile
| Name | Description | Value |
|---|---|---|
| clusterBootstrapAccount | Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). | string |
| clusterOperatorAccount | Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. | string |
| clusterSubnetType | Cluster subnet type. | "MultiSubnet" "SingleSubnet" |
| domainFqdn | Fully qualified name of the domain. | string |
| fileShareWitnessPath | Optional path for fileshare witness. | string |
| ouPath | Organizational Unit path in which the nodes and cluster will be present. | string |
| sqlServiceAccount | Account name under which SQL service will run on all participating SQL virtual machines in the cluster. | string |
| storageAccountPrimaryKey | Primary key of the witness storage account. | string |
| storageAccountUrl | Fully qualified ARM resource id of the witness storage account. | string |