Microsoft.SqlVirtualMachine sqlVirtualMachineGroups/availabilityGroupListeners 2017-03-01-preview
Bicep resource definition
The sqlVirtualMachineGroups/availabilityGroupListeners 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/availabilityGroupListeners resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2017-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
availabilityGroupName: 'string'
createDefaultAvailabilityGroupIfNotExist: bool
loadBalancerConfigurations: [
{
loadBalancerResourceId: 'string'
privateIpAddress: {
ipAddress: 'string'
subnetResourceId: 'string'
}
probePort: int
publicIpAddressResourceId: 'string'
sqlVirtualMachineInstances: [
'string'
]
}
]
port: int
}
}
Property values
sqlVirtualMachineGroups/availabilityGroupListeners
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: sqlVirtualMachineGroups |
| properties | Resource properties. | AvailabilityGroupListenerProperties |
AvailabilityGroupListenerProperties
| Name | Description | Value |
|---|---|---|
| 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[] |
| port | Listener port. | int |
LoadBalancerConfiguration
| 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[] |
PrivateIPAddress
| Name | Description | Value |
|---|---|---|
| ipAddress | Private IP address bound to the availability group listener. | string |
| subnetResourceId | Subnet used to include private IP. | string |
Quickstart templates
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. |
ARM template resource definition
The sqlVirtualMachineGroups/availabilityGroupListeners 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/availabilityGroupListeners resource, add the following JSON to your template.
{
"type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners",
"apiVersion": "2017-03-01-preview",
"name": "string",
"properties": {
"availabilityGroupName": "string",
"createDefaultAvailabilityGroupIfNotExist": "bool",
"loadBalancerConfigurations": [
{
"loadBalancerResourceId": "string",
"privateIpAddress": {
"ipAddress": "string",
"subnetResourceId": "string"
},
"probePort": "int",
"publicIpAddressResourceId": "string",
"sqlVirtualMachineInstances": [ "string" ]
}
],
"port": "int"
}
}
Property values
sqlVirtualMachineGroups/availabilityGroupListeners
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners' |
| apiVersion | The resource api version | '2017-03-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 |
AvailabilityGroupListenerProperties
| Name | Description | Value |
|---|---|---|
| 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[] |
| port | Listener port. | int |
LoadBalancerConfiguration
| 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[] |
PrivateIPAddress
| Name | Description | Value |
|---|---|---|
| ipAddress | Private IP address bound to the availability group listener. | string |
| subnetResourceId | Subnet used to include private IP. | string |
Quickstart templates
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. |
Terraform (AzAPI provider) resource definition
The sqlVirtualMachineGroups/availabilityGroupListeners 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/availabilityGroupListeners resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2017-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
availabilityGroupName = "string"
createDefaultAvailabilityGroupIfNotExist = bool
loadBalancerConfigurations = [
{
loadBalancerResourceId = "string"
privateIpAddress = {
ipAddress = "string"
subnetResourceId = "string"
}
probePort = int
publicIpAddressResourceId = "string"
sqlVirtualMachineInstances = [
"string"
]
}
]
port = int
}
})
}
Property values
sqlVirtualMachineGroups/availabilityGroupListeners
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2017-03-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: sqlVirtualMachineGroups |
| properties | Resource properties. | AvailabilityGroupListenerProperties |
AvailabilityGroupListenerProperties
| Name | Description | Value |
|---|---|---|
| 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[] |
| port | Listener port. | int |
LoadBalancerConfiguration
| 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[] |
PrivateIPAddress
| Name | Description | Value |
|---|---|---|
| ipAddress | Private IP address bound to the availability group listener. | string |
| subnetResourceId | Subnet used to include private IP. | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for