Microsoft.AzureArcData sqlAvailabilityGroups/databases

Bicep resource definition

The sqlAvailabilityGroups/databases resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/sqlAvailabilityGroups/databases resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureArcData/sqlAvailabilityGroups/databases@2023-03-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    groupDatabaseId: 'string'
    value: [
      {
        databaseStateDesc: 'string'
        isCommitParticipant: bool
        isLocal: bool
        isPrimaryReplica: bool
        isSuspended: bool
        replicaName: 'string'
        suspendReasonDesc: 'string'
        synchronizationHealthDesc: 'string'
        synchronizationStateDesc: 'string'
      }
    ]
  }
}

Property values

sqlAvailabilityGroups/databases

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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: sqlAvailabilityGroups
properties Properties of Arc Sql Availability Group Multiple Database Replica SqlAvailabilityGroupMultiDatabaseReplicaResourceProp... (required)

SqlAvailabilityGroupMultiDatabaseReplicaResourceProp...

Name Description Value
groupDatabaseId ID GUID of the database for availability group. string
value Array of Arc Sql Availability Group Database Replicas. SqlAvailabilityGroupDatabaseReplicaResourcePropertie...[]

SqlAvailabilityGroupDatabaseReplicaResourcePropertie...

Name Description Value
databaseStateDesc Description of the database state of the availability replica. string
isCommitParticipant Whether this replica is transaction committer. bool
isLocal Whether the availability database is local. bool
isPrimaryReplica Returns 1 if the replica is primary, or 0 if it is a secondary replica. bool
isSuspended Whether this data movement is suspended. bool
replicaName the database replica name. string
suspendReasonDesc Description of the database suspended state reason. string
synchronizationHealthDesc Description of the health of database. string
synchronizationStateDesc Description of the data-movement state. string

ARM template resource definition

The sqlAvailabilityGroups/databases resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/sqlAvailabilityGroups/databases resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/databases",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "groupDatabaseId": "string",
    "value": [
      {
        "databaseStateDesc": "string",
        "isCommitParticipant": "bool",
        "isLocal": "bool",
        "isPrimaryReplica": "bool",
        "isSuspended": "bool",
        "replicaName": "string",
        "suspendReasonDesc": "string",
        "synchronizationHealthDesc": "string",
        "synchronizationStateDesc": "string"
      }
    ]
  }
}

Property values

sqlAvailabilityGroups/databases

Name Description Value
type The resource type 'Microsoft.AzureArcData/sqlAvailabilityGroups/databases'
apiVersion The resource api version '2023-03-15-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Properties of Arc Sql Availability Group Multiple Database Replica SqlAvailabilityGroupMultiDatabaseReplicaResourceProp... (required)

SqlAvailabilityGroupMultiDatabaseReplicaResourceProp...

Name Description Value
groupDatabaseId ID GUID of the database for availability group. string
value Array of Arc Sql Availability Group Database Replicas. SqlAvailabilityGroupDatabaseReplicaResourcePropertie...[]

SqlAvailabilityGroupDatabaseReplicaResourcePropertie...

Name Description Value
databaseStateDesc Description of the database state of the availability replica. string
isCommitParticipant Whether this replica is transaction committer. bool
isLocal Whether the availability database is local. bool
isPrimaryReplica Returns 1 if the replica is primary, or 0 if it is a secondary replica. bool
isSuspended Whether this data movement is suspended. bool
replicaName the database replica name. string
suspendReasonDesc Description of the database suspended state reason. string
synchronizationHealthDesc Description of the health of database. string
synchronizationStateDesc Description of the data-movement state. string

Terraform (AzAPI provider) resource definition

The sqlAvailabilityGroups/databases 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.AzureArcData/sqlAvailabilityGroups/databases resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/sqlAvailabilityGroups/databases@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      groupDatabaseId = "string"
      value = [
        {
          databaseStateDesc = "string"
          isCommitParticipant = bool
          isLocal = bool
          isPrimaryReplica = bool
          isSuspended = bool
          replicaName = "string"
          suspendReasonDesc = "string"
          synchronizationHealthDesc = "string"
          synchronizationStateDesc = "string"
        }
      ]
    }
  })
}

Property values

sqlAvailabilityGroups/databases

Name Description Value
type The resource type "Microsoft.AzureArcData/sqlAvailabilityGroups/databases@2023-03-15-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sqlAvailabilityGroups
tags Resource tags. Dictionary of tag names and values.
properties Properties of Arc Sql Availability Group Multiple Database Replica SqlAvailabilityGroupMultiDatabaseReplicaResourceProp... (required)

SqlAvailabilityGroupMultiDatabaseReplicaResourceProp...

Name Description Value
groupDatabaseId ID GUID of the database for availability group. string
value Array of Arc Sql Availability Group Database Replicas. SqlAvailabilityGroupDatabaseReplicaResourcePropertie...[]

SqlAvailabilityGroupDatabaseReplicaResourcePropertie...

Name Description Value
databaseStateDesc Description of the database state of the availability replica. string
isCommitParticipant Whether this replica is transaction committer. bool
isLocal Whether the availability database is local. bool
isPrimaryReplica Returns 1 if the replica is primary, or 0 if it is a secondary replica. bool
isSuspended Whether this data movement is suspended. bool
replicaName the database replica name. string
suspendReasonDesc Description of the database suspended state reason. string
synchronizationHealthDesc Description of the health of database. string
synchronizationStateDesc Description of the data-movement state. string
  • Last updated on