Microsoft.AzureArcData sqlAvailabilityGroups/sqlServerInstances

ARM template resource definition

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

{
  "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "configure": {
      "availabilityModeDesc": "string",
      "backupPriority": "int",
      "createDate": "string",
      "endpointUrl": "string",
      "failoverModeDesc": "string",
      "modifyDate": "string",
      "primaryRoleAllowConnectionsDesc": "string",
      "readOnlyRoutingUrl": "string",
      "readWriteRoutingUrl": "string",
      "secondaryRoleAllowConnectionsDesc": "string",
      "seedingModeDesc": "string",
      "sessionTimeout": "int"
    },
    "replicaId": "string",
    "replicaName": "string",
    "state": {
      "availabilityGroupReplicaRole": "string",
      "connectedStateDesc": "string",
      "lastConnectErrorDescription": "string",
      "lastConnectErrorTimestamp": "string",
      "operationalStateDesc": "string",
      "recoveryHealthDesc": "string",
      "synchronizationHealthDesc": "string"
    }
  }
}

Property values

sqlAvailabilityGroups/sqlServerInstances

Name Description Value
type The resource type 'Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances'
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 Replica SqlAvailabilityGroupReplicaResourceProperties (required)

SqlAvailabilityGroupReplicaResourceProperties

Name Description Value
configure null AvailabilityGroupConfigure
replicaId ID GUID of the availability group. string
replicaName the replica name. string
state null AvailabilityGroupState

AvailabilityGroupConfigure

Name Description Value
availabilityModeDesc Availability Synchronization mode description of availability group replica. string
backupPriority Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. int
createDate Date that the replica was created. string
endpointUrl Mirroring endpoint URL of availability group replica string
failoverModeDesc failover mode description of the availability group replica. string
modifyDate Date that the replica was modified. string
primaryRoleAllowConnectionsDesc Allowed the connections for primary role of the 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
secondaryRoleAllowConnectionsDesc Allowed the connections for secondary role of availability group replica. string
seedingModeDesc Describes seeding mode. string
sessionTimeout The time-out period of availability group session replica, in seconds. int

AvailabilityGroupState

Name Description Value
availabilityGroupReplicaRole Role description of the availability group replica. string
connectedStateDesc Connected state description of the availability group replica. string
lastConnectErrorDescription Last connect error description of the availability group replica. string
lastConnectErrorTimestamp Last connect error time stamp of the availability group replica. string
operationalStateDesc Operation state description of the availability group replica string
recoveryHealthDesc Recovery health description of the availability group replica. string
synchronizationHealthDesc Synchronization health description of the availability group replica. string