Bicep resource definition
The sqlServerInstances/availabilityGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AzureArcData/sqlServerInstances/availabilityGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AzureArcData/sqlServerInstances/availabilityGroups@2024-01-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
databases: {
value: [
{
databaseName: 'string'
}
]
}
info: {
basicFeatures: bool
dbFailover: bool
dtcSupport: bool
failureConditionLevel: int
healthCheckTimeout: int
isContained: bool
isDistributed: bool
requiredSynchronizedSecondariesToCommit: int
}
replicas: {
value: [
{
configure: {
backupPriority: int
endpointUrl: 'string'
readOnlyRoutingUrl: 'string'
readWriteRoutingUrl: 'string'
sessionTimeout: int
}
replicaName: 'string'
state: {}
}
]
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AzureArcData/sqlServerInstances/availabilityGroups
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
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: sqlServerInstances |
| properties |
Properties of Arc Sql Server availability group |
SqlServerAvailabilityGroupResourceProperties (required) |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| Name |
Description |
Value |
| backupPriority |
Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. |
int |
| endpointUrl |
Mirroring endpoint URL of availability group replica |
string |
| readOnlyRoutingUrl |
Connectivity endpoint (URL) of the read only availability replica. |
string |
| readWriteRoutingUrl |
Connectivity endpoint (URL) of the read write availability replica. |
string |
| sessionTimeout |
The time-out period of availability group session replica, in seconds. |
int |
AvailabilityGroupInfo
| Name |
Description |
Value |
| basicFeatures |
Specifies whether this is a basic availability group. |
bool |
| dbFailover |
Specifies whether the availability group supports failover for database health conditions. |
bool |
| dtcSupport |
Specifies whether DTC support has been enabled for this availability group. |
bool |
| failureConditionLevel |
User-defined failure condition level under which an automatic failover must be triggered. |
int |
| healthCheckTimeout |
Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. |
int |
| isContained |
SQL Server availability group contained system databases. |
bool |
| isDistributed |
Specifies whether this is a distributed availability group. |
bool |
| requiredSynchronizedSecondariesToCommit |
The number of secondary replicas that must be in a synchronized state for a commit to complete. |
int |
AvailabilityGroupState
SqlAvailabilityGroupDatabaseReplicaResourceProperties
| Name |
Description |
Value |
| databaseName |
the database name. |
string |
SqlAvailabilityGroupReplicaResourceProperties
SqlServerAvailabilityGroupResourceProperties
SqlServerAvailabilityGroupResourcePropertiesDatabases
SqlServerAvailabilityGroupResourcePropertiesReplicas
ARM template resource definition
The sqlServerInstances/availabilityGroups resource type can be deployed with operations that target:
Usage Examples
To create a Microsoft.AzureArcData/sqlServerInstances/availabilityGroups resource, add the following JSON to your template.
{
"type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups",
"apiVersion": "2024-01-01",
"name": "string",
"location": "string",
"properties": {
"databases": {
"value": [
{
"databaseName": "string"
}
]
},
"info": {
"basicFeatures": "bool",
"dbFailover": "bool",
"dtcSupport": "bool",
"failureConditionLevel": "int",
"healthCheckTimeout": "int",
"isContained": "bool",
"isDistributed": "bool",
"requiredSynchronizedSecondariesToCommit": "int"
},
"replicas": {
"value": [
{
"configure": {
"backupPriority": "int",
"endpointUrl": "string",
"readOnlyRoutingUrl": "string",
"readWriteRoutingUrl": "string",
"sessionTimeout": "int"
},
"replicaName": "string",
"state": {
}
}
]
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AzureArcData/sqlServerInstances/availabilityGroups
| Name |
Description |
Value |
| apiVersion |
The api version |
'2024-01-01' |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (required) |
| properties |
Properties of Arc Sql Server availability group |
SqlServerAvailabilityGroupResourceProperties (required) |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.AzureArcData/sqlServerInstances/availabilityGroups' |
| Name |
Description |
Value |
| backupPriority |
Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. |
int |
| endpointUrl |
Mirroring endpoint URL of availability group replica |
string |
| readOnlyRoutingUrl |
Connectivity endpoint (URL) of the read only availability replica. |
string |
| readWriteRoutingUrl |
Connectivity endpoint (URL) of the read write availability replica. |
string |
| sessionTimeout |
The time-out period of availability group session replica, in seconds. |
int |
AvailabilityGroupInfo
| Name |
Description |
Value |
| basicFeatures |
Specifies whether this is a basic availability group. |
bool |
| dbFailover |
Specifies whether the availability group supports failover for database health conditions. |
bool |
| dtcSupport |
Specifies whether DTC support has been enabled for this availability group. |
bool |
| failureConditionLevel |
User-defined failure condition level under which an automatic failover must be triggered. |
int |
| healthCheckTimeout |
Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. |
int |
| isContained |
SQL Server availability group contained system databases. |
bool |
| isDistributed |
Specifies whether this is a distributed availability group. |
bool |
| requiredSynchronizedSecondariesToCommit |
The number of secondary replicas that must be in a synchronized state for a commit to complete. |
int |
AvailabilityGroupState
SqlAvailabilityGroupDatabaseReplicaResourceProperties
| Name |
Description |
Value |
| databaseName |
the database name. |
string |
SqlAvailabilityGroupReplicaResourceProperties
SqlServerAvailabilityGroupResourceProperties
SqlServerAvailabilityGroupResourcePropertiesDatabases
SqlServerAvailabilityGroupResourcePropertiesReplicas
The sqlServerInstances/availabilityGroups resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
To create a Microsoft.AzureArcData/sqlServerInstances/availabilityGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups@2024-01-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
databases = {
value = [
{
databaseName = "string"
}
]
}
info = {
basicFeatures = bool
dbFailover = bool
dtcSupport = bool
failureConditionLevel = int
healthCheckTimeout = int
isContained = bool
isDistributed = bool
requiredSynchronizedSecondariesToCommit = int
}
replicas = {
value = [
{
configure = {
backupPriority = int
endpointUrl = "string"
readOnlyRoutingUrl = "string"
readWriteRoutingUrl = "string"
sessionTimeout = int
}
replicaName = "string"
state = {
}
}
]
}
}
}
}
Property Values
Microsoft.AzureArcData/sqlServerInstances/availabilityGroups
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| 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: sqlServerInstances |
| properties |
Properties of Arc Sql Server availability group |
SqlServerAvailabilityGroupResourceProperties (required) |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.AzureArcData/sqlServerInstances/availabilityGroups@2024-01-01" |
| Name |
Description |
Value |
| backupPriority |
Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. |
int |
| endpointUrl |
Mirroring endpoint URL of availability group replica |
string |
| readOnlyRoutingUrl |
Connectivity endpoint (URL) of the read only availability replica. |
string |
| readWriteRoutingUrl |
Connectivity endpoint (URL) of the read write availability replica. |
string |
| sessionTimeout |
The time-out period of availability group session replica, in seconds. |
int |
AvailabilityGroupInfo
| Name |
Description |
Value |
| basicFeatures |
Specifies whether this is a basic availability group. |
bool |
| dbFailover |
Specifies whether the availability group supports failover for database health conditions. |
bool |
| dtcSupport |
Specifies whether DTC support has been enabled for this availability group. |
bool |
| failureConditionLevel |
User-defined failure condition level under which an automatic failover must be triggered. |
int |
| healthCheckTimeout |
Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. |
int |
| isContained |
SQL Server availability group contained system databases. |
bool |
| isDistributed |
Specifies whether this is a distributed availability group. |
bool |
| requiredSynchronizedSecondariesToCommit |
The number of secondary replicas that must be in a synchronized state for a commit to complete. |
int |
AvailabilityGroupState
SqlAvailabilityGroupDatabaseReplicaResourceProperties
| Name |
Description |
Value |
| databaseName |
the database name. |
string |
SqlAvailabilityGroupReplicaResourceProperties
SqlServerAvailabilityGroupResourceProperties
SqlServerAvailabilityGroupResourcePropertiesDatabases
SqlServerAvailabilityGroupResourcePropertiesReplicas