The sqlVirtualMachineGroups/availabilityGroupListeners resource type can be deployed to:
For a list of changed properties in each API version, see change log.
To create a Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners resource, add the following JSON to your template.
{
"type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners",
"apiVersion": "2022-08-01-preview",
"name": "string",
"properties": {
"availabilityGroupConfiguration": {
"replicas": [
{
"commit": "string",
"failover": "string",
"readableSecondary": "string",
"role": "string",
"sqlVirtualMachineInstanceId": "string"
}
]
},
"availabilityGroupName": "string",
"createDefaultAvailabilityGroupIfNotExist": "bool",
"loadBalancerConfigurations": [
{
"loadBalancerResourceId": "string",
"privateIpAddress": {
"ipAddress": "string",
"subnetResourceId": "string"
},
"probePort": "int",
"publicIpAddressResourceId": "string",
"sqlVirtualMachineInstances": [ "string" ]
}
],
"multiSubnetIpConfigurations": [
{
"privateIpAddress": {
"ipAddress": "string",
"subnetResourceId": "string"
},
"sqlVirtualMachineInstance": "string"
}
],
"port": "int"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners' |
apiVersion | The resource api version | '2022-08-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Resource properties. | AvailabilityGroupListenerProperties |
Name | Description | Value |
---|---|---|
availabilityGroupConfiguration | Availability Group configuration. | AgConfiguration |
availabilityGroupName | Name of the availability group. | string |
createDefaultAvailabilityGroupIfNotExist | Create a default availability group if it does not exist. | bool |
loadBalancerConfigurations | List of load balancer configurations for an availability group listener. | LoadBalancerConfiguration[] |
multiSubnetIpConfigurations | List of multi subnet IP configurations for an AG listener. | MultiSubnetIpConfiguration[] |
port | Listener port. | int |
Name | Description | Value |
---|---|---|
replicas | Replica configurations. | AgReplica[] |
Name | Description | Value |
---|---|---|
commit | Replica commit mode in availability group. | 'ASYNCHRONOUS_COMMIT' 'SYNCHRONOUS_COMMIT' |
failover | Replica failover mode in availability group. | 'AUTOMATIC' 'MANUAL' |
readableSecondary | Replica readable secondary mode in availability group. | 'ALL' 'NO' 'READ_ONLY' |
role | Replica Role in availability group. | 'PRIMARY' 'SECONDARY' |
sqlVirtualMachineInstanceId | Sql VirtualMachine Instance Id. | string |
Name | Description | Value |
---|---|---|
loadBalancerResourceId | Resource id of the load balancer. | string |
privateIpAddress | Private IP address. | PrivateIPAddress |
probePort | Probe port. | int |
publicIpAddressResourceId | Resource id of the public IP. | string |
sqlVirtualMachineInstances | List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. | string[] |
Name | Description | Value |
---|---|---|
ipAddress | Private IP address bound to the availability group listener. | string |
subnetResourceId | Subnet used to include private IP. | string |
Name | Description | Value |
---|---|---|
privateIpAddress | Private IP address. | PrivateIPAddress (required) |
sqlVirtualMachineInstance | SQL virtual machine instance resource id that are enrolled into the availability group listener. | string (required) |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Create SQL AvailabilityGroup listener on existing Always ON setup |
Deploy SQL AvailabilityGroup listener on existing Always ON setup. This creates Listener on an existing SQL Availability Group, sets up corresponding load balancer rules and probe ports on Azure Load balancer to get the listener connections working. |