Share via

Microsoft.Sql servers/failoverGroups 2023-05-01-preview

  • Article

Bicep resource definition

The servers/failoverGroups 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.Sql/servers/failoverGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/failoverGroups@2023-05-01-preview' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    databases: [
      'string'
    ]
    partnerServers: [
      {
        id: 'string'
      }
    ]
    readWriteEndpoint: {
      failoverPolicy: 'string'
      failoverWithDataLossGracePeriodMinutes: int
    }
    secondaryType: 'string'
  }
}

Property values

servers/failoverGroups

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-63

Valid characters:
Lowercase letters, numbers, and hyphens.

Can't start or end with hyphen.

Resource name must be unique across Azure.
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: servers
properties Resource properties. FailoverGroupProperties

FailoverGroupProperties

Name Description Value
databases List of databases in the failover group. string[]
partnerServers List of partner server information for the failover group. PartnerInfo[] (required)
readWriteEndpoint Read-write endpoint of the failover group instance. FailoverGroupReadWriteEndpoint (required)
secondaryType Databases secondary type on partner server. 'Geo'
'Standby'

PartnerInfo

Name Description Value
id Resource identifier of the partner server. string (required)

FailoverGroupReadWriteEndpoint

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure SQL Servers and Database with Failover Group

Deploy to Azure		 Creates two Azure SQL servers, a database, and a failover group.

ARM template resource definition

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

{
  "type": "Microsoft.Sql/servers/failoverGroups",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "databases": [ "string" ],
    "partnerServers": [
      {
        "id": "string"
      }
    ],
    "readWriteEndpoint": {
      "failoverPolicy": "string",
      "failoverWithDataLossGracePeriodMinutes": "int"
    },
    "secondaryType": "string"
  }
}

Property values

servers/failoverGroups

Name Description Value
type The resource type 'Microsoft.Sql/servers/failoverGroups'
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)

Character limit: 1-63

Valid characters:
Lowercase letters, numbers, and hyphens.

Can't start or end with hyphen.

Resource name must be unique across Azure.
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Resource properties. FailoverGroupProperties

FailoverGroupProperties

Name Description Value
databases List of databases in the failover group. string[]
partnerServers List of partner server information for the failover group. PartnerInfo[] (required)
readWriteEndpoint Read-write endpoint of the failover group instance. FailoverGroupReadWriteEndpoint (required)
secondaryType Databases secondary type on partner server. 'Geo'
'Standby'

PartnerInfo

Name Description Value
id Resource identifier of the partner server. string (required)

FailoverGroupReadWriteEndpoint

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure SQL Servers and Database with Failover Group

Deploy to Azure		 Creates two Azure SQL servers, a database, and a failover group.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/failoverGroups@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      databases = [
        "string"
      ]
      partnerServers = [
        {
          id = "string"
        }
      ]
      readWriteEndpoint = {
        failoverPolicy = "string"
        failoverWithDataLossGracePeriodMinutes = int
      }
      secondaryType = "string"
    }
  })
}

Property values

servers/failoverGroups

Name Description Value
type The resource type "Microsoft.Sql/servers/failoverGroups@2023-05-01-preview"
name The resource name string (required)

Character limit: 1-63

Valid characters:
Lowercase letters, numbers, and hyphens.

Can't start or end with hyphen.

Resource name must be unique across Azure.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
tags Resource tags. Dictionary of tag names and values.
properties Resource properties. FailoverGroupProperties

FailoverGroupProperties

Name Description Value
databases List of databases in the failover group. string[]
partnerServers List of partner server information for the failover group. PartnerInfo[] (required)
readWriteEndpoint Read-write endpoint of the failover group instance. FailoverGroupReadWriteEndpoint (required)
secondaryType Databases secondary type on partner server. "Geo"
"Standby"

PartnerInfo

Name Description Value
id Resource identifier of the partner server. string (required)

FailoverGroupReadWriteEndpoint

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