Microsoft.Sql locations/instanceFailoverGroups 2017-10-01-preview

Template format

To create a Microsoft.Sql/locations/instanceFailoverGroups resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "apiVersion": "2017-10-01-preview",
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "string",
      "failoverWithDataLossGracePeriodMinutes": "integer"
    },
    "readOnlyEndpoint": {
      "failoverPolicy": "string"
    },
    "partnerRegions": [
      {
        "location": "string"
      }
    ],
    "managedInstancePairs": [
      {
        "primaryManagedInstanceId": "string",
        "partnerManagedInstanceId": "string"
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Sql/locations/instanceFailoverGroups object

Name Type Required Value
name string Yes The name of the failover group.
type enum Yes instanceFailoverGroups
-or-
Microsoft.Sql/locations/instanceFailoverGroups

See Set name and type for child resources.
apiVersion enum Yes 2017-10-01-preview
properties object Yes Resource properties. - InstanceFailoverGroupProperties object

InstanceFailoverGroupProperties object

Name Type Required Value
readWriteEndpoint object Yes Read-write endpoint of the failover group instance. - InstanceFailoverGroupReadWriteEndpoint object
readOnlyEndpoint object No Read-only endpoint of the failover group instance. - InstanceFailoverGroupReadOnlyEndpoint object
partnerRegions array Yes Partner region information for the failover group. - PartnerRegionInfo object
managedInstancePairs array Yes List of managed instance pairs in the failover group. - ManagedInstancePairInfo object

InstanceFailoverGroupReadWriteEndpoint object

Name Type Required Value
failoverPolicy enum Yes Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. - Manual or Automatic
failoverWithDataLossGracePeriodMinutes integer No Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

InstanceFailoverGroupReadOnlyEndpoint object

Name Type Required Value
failoverPolicy enum No Failover policy of the read-only endpoint for the failover group. - Disabled or Enabled

PartnerRegionInfo object

Name Type Required Value
location string No Geo location of the partner managed instances.

ManagedInstancePairInfo object

Name Type Required Value
primaryManagedInstanceId string No Id of Primary Managed Instance in pair.
partnerManagedInstanceId string No Id of Partner Managed Instance in pair.