Microsoft.Sql managedInstances/distributedAvailabilityGroups 2022-05-01-preview
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@2022-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
primaryAvailabilityGroupName: 'string'
replicationMode: 'string'
secondaryAvailabilityGroupName: 'string'
sourceEndpoint: 'string'
targetDatabase: 'string'
}
}
Property values
managedInstances/distributedAvailabilityGroups
| 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: managedInstances |
| properties | Resource properties. | DistributedAvailabilityGroupProperties |
DistributedAvailabilityGroupProperties
| Name | Description | Value |
|---|---|---|
| primaryAvailabilityGroupName | The primary availability group name | string |
| replicationMode | The replication mode of a distributed availability group. Parameter will be ignored during link creation. | 'Async' 'Sync' |
| secondaryAvailabilityGroupName | The secondary availability group name | string |
| sourceEndpoint | The source endpoint | string |
| targetDatabase | The name of the target database | string |
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": "2022-05-01-preview",
"name": "string",
"properties": {
"primaryAvailabilityGroupName": "string",
"replicationMode": "string",
"secondaryAvailabilityGroupName": "string",
"sourceEndpoint": "string",
"targetDatabase": "string"
}
}
Property values
managedInstances/distributedAvailabilityGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/managedInstances/distributedAvailabilityGroups' |
| apiVersion | The resource api version | '2022-05-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. | DistributedAvailabilityGroupProperties |
DistributedAvailabilityGroupProperties
| Name | Description | Value |
|---|---|---|
| primaryAvailabilityGroupName | The primary availability group name | string |
| replicationMode | The replication mode of a distributed availability group. Parameter will be ignored during link creation. | 'Async' 'Sync' |
| secondaryAvailabilityGroupName | The secondary availability group name | string |
| sourceEndpoint | The source endpoint | string |
| targetDatabase | The name of the target database | string |
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@2022-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
primaryAvailabilityGroupName = "string"
replicationMode = "string"
secondaryAvailabilityGroupName = "string"
sourceEndpoint = "string"
targetDatabase = "string"
}
})
}
Property values
managedInstances/distributedAvailabilityGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2022-05-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: managedInstances |
| properties | Resource properties. | DistributedAvailabilityGroupProperties |
DistributedAvailabilityGroupProperties
| Name | Description | Value |
|---|---|---|
| primaryAvailabilityGroupName | The primary availability group name | string |
| replicationMode | The replication mode of a distributed availability group. Parameter will be ignored during link creation. | "Async" "Sync" |
| secondaryAvailabilityGroupName | The secondary availability group name | string |
| sourceEndpoint | The source endpoint | string |
| targetDatabase | The name of the target database | string |