The locations/instanceFailoverGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Sql/locations/instanceFailoverGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/locations/instanceFailoverGroups",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"managedInstancePairs": [
{
"partnerManagedInstanceId": "string",
"primaryManagedInstanceId": "string"
}
],
"partnerRegions": [
{
"location": "string"
}
],
"readWriteEndpoint": {
"failoverPolicy": "string",
"failoverWithDataLossGracePeriodMinutes": "int"
},
"secondaryType": "string"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Sql/locations/instanceFailoverGroups' |
apiVersion | The resource api version | '2023-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. | InstanceFailoverGroupProperties |
Name | Description | Value |
---|---|---|
managedInstancePairs | List of managed instance pairs in the failover group. | ManagedInstancePairInfo[] (required) |
partnerRegions | Partner region information for the failover group. | PartnerRegionInfo[] (required) |
readWriteEndpoint | Read-write endpoint of the failover group instance. | InstanceFailoverGroupReadWriteEndpoint (required) |
secondaryType | Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. | 'Geo' 'Standby' |
Name | Description | Value |
---|---|---|
partnerManagedInstanceId | Id of Partner Managed Instance in pair. | string |
primaryManagedInstanceId | Id of Primary Managed Instance in pair. | string |
Name | Description | Value |
---|---|---|
location | Geo location of the partner managed instances. | string |
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | 'Automatic' 'Manual' (required) |
failoverWithDataLossGracePeriodMinutes | Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | int |