Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The managedInstances/distributedAvailabilityGroups resource type can be deployed with operations that target:
- 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.Sql/managedInstances/distributedAvailabilityGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
databases: [
{
databaseName: 'string'
}
]
failoverMode: 'string'
instanceAvailabilityGroupName: 'string'
instanceLinkRole: 'string'
partnerAvailabilityGroupName: 'string'
partnerEndpoint: 'string'
replicationMode: 'string'
seedingMode: 'string'
}
}
Property Values
Microsoft.Sql/managedInstances/distributedAvailabilityGroups
| Name | Description | Value |
|---|---|---|
| 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: managedInstances |
| properties | Resource properties. | DistributedAvailabilityGroupProperties |
DistributedAvailabilityGroupDatabase
| Name | Description | Value |
|---|---|---|
| databaseName | The name of the database in link | string |
DistributedAvailabilityGroupProperties
| Name | Description | Value |
|---|---|---|
| databases | Databases in the distributed availability group | DistributedAvailabilityGroupDatabase[] |
| failoverMode | The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. | 'Manual' 'None' |
| instanceAvailabilityGroupName | Managed instance side availability group name | string |
| instanceLinkRole | Managed instance side link role | 'Primary' 'Secondary' |
| partnerAvailabilityGroupName | SQL server side availability group name | string |
| partnerEndpoint | SQL server side endpoint - IP or DNS resolvable name | string |
| replicationMode | Replication mode of the link | 'Async' 'Sync' |
| seedingMode | Database seeding mode – can be Automatic (default), or Manual for supported scenarios. | 'Automatic' 'Manual' |
ARM template resource definition
The managedInstances/distributedAvailabilityGroups resource type can be deployed with operations that target:
- 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.Sql/managedInstances/distributedAvailabilityGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"databases": [
{
"databaseName": "string"
}
],
"failoverMode": "string",
"instanceAvailabilityGroupName": "string",
"instanceLinkRole": "string",
"partnerAvailabilityGroupName": "string",
"partnerEndpoint": "string",
"replicationMode": "string",
"seedingMode": "string"
}
}
Property Values
Microsoft.Sql/managedInstances/distributedAvailabilityGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| name | The resource name | string (required) |
| properties | Resource properties. | DistributedAvailabilityGroupProperties |
| type | The resource type | 'Microsoft.Sql/managedInstances/distributedAvailabilityGroups' |
DistributedAvailabilityGroupDatabase
| Name | Description | Value |
|---|---|---|
| databaseName | The name of the database in link | string |
DistributedAvailabilityGroupProperties
| Name | Description | Value |
|---|---|---|
| databases | Databases in the distributed availability group | DistributedAvailabilityGroupDatabase[] |
| failoverMode | The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. | 'Manual' 'None' |
| instanceAvailabilityGroupName | Managed instance side availability group name | string |
| instanceLinkRole | Managed instance side link role | 'Primary' 'Secondary' |
| partnerAvailabilityGroupName | SQL server side availability group name | string |
| partnerEndpoint | SQL server side endpoint - IP or DNS resolvable name | string |
| replicationMode | Replication mode of the link | 'Async' 'Sync' |
| seedingMode | Database seeding mode – can be Automatic (default), or Manual for supported scenarios. | 'Automatic' 'Manual' |
Usage Examples
Terraform (AzAPI provider) resource definition
The managedInstances/distributedAvailabilityGroups 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.Sql/managedInstances/distributedAvailabilityGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2024-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
databases = [
{
databaseName = "string"
}
]
failoverMode = "string"
instanceAvailabilityGroupName = "string"
instanceLinkRole = "string"
partnerAvailabilityGroupName = "string"
partnerEndpoint = "string"
replicationMode = "string"
seedingMode = "string"
}
}
}
Property Values
Microsoft.Sql/managedInstances/distributedAvailabilityGroups
| Name | Description | Value |
|---|---|---|
| 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: managedInstances |
| properties | Resource properties. | DistributedAvailabilityGroupProperties |
| type | The resource type | "Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2024-05-01-preview" |
DistributedAvailabilityGroupDatabase
| Name | Description | Value |
|---|---|---|
| databaseName | The name of the database in link | string |
DistributedAvailabilityGroupProperties
| Name | Description | Value |
|---|---|---|
| databases | Databases in the distributed availability group | DistributedAvailabilityGroupDatabase[] |
| failoverMode | The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. | 'Manual' 'None' |
| instanceAvailabilityGroupName | Managed instance side availability group name | string |
| instanceLinkRole | Managed instance side link role | 'Primary' 'Secondary' |
| partnerAvailabilityGroupName | SQL server side availability group name | string |
| partnerEndpoint | SQL server side endpoint - IP or DNS resolvable name | string |
| replicationMode | Replication mode of the link | 'Async' 'Sync' |
| seedingMode | Database seeding mode – can be Automatic (default), or Manual for supported scenarios. | 'Automatic' 'Manual' |