Share via

Microsoft.AzureArcData sqlManagedInstances/failoverGroups

  • Article
  • 02/13/2025
Choose a deployment language

Bicep resource definition

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

resource symbolicname 'Microsoft.AzureArcData/sqlManagedInstances/failoverGroups@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    partnerManagedInstanceId: 'string'
    spec: {
      partnerMI: 'string'
      partnerMirroringCert: 'string'
      partnerMirroringURL: 'string'
      partnerSyncMode: 'string'
      role: 'string'
      sharedName: 'string'
      sourceMI: 'string'
    }
    status: any(...)
  }
}

Property Values

FailoverGroupProperties

Name Description Value
partnerManagedInstanceId The resource ID of the partner SQL managed instance. string (required)
spec The specifications of the failover group resource. FailoverGroupSpec (required)
status The status of the failover group custom resource. any

FailoverGroupSpec

Name Description Value
partnerMI The name of the partner SQL managed instance. string
partnerMirroringCert The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. string
partnerMirroringURL The mirroring endpoint URL of the partner SQL managed instance. string
partnerSyncMode The partner sync mode of the SQL managed instance. 'async'
'sync'
role The role of the SQL managed instance in this failover group. 'force-primary-allow-data-loss'
'force-secondary'
'primary'
'secondary' (required)
sharedName The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. string
sourceMI The name of the SQL managed instance with this failover group role. string

Microsoft.AzureArcData/sqlManagedInstances/failoverGroups

Name Description Value
name The resource name string (required)
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: sqlManagedInstances
properties null FailoverGroupProperties (required)

ARM template resource definition

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

{
  "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "properties": {
    "partnerManagedInstanceId": "string",
    "spec": {
      "partnerMI": "string",
      "partnerMirroringCert": "string",
      "partnerMirroringURL": "string",
      "partnerSyncMode": "string",
      "role": "string",
      "sharedName": "string",
      "sourceMI": "string"
    },
    "status": {}
  }
}

Property Values

FailoverGroupProperties

Name Description Value
partnerManagedInstanceId The resource ID of the partner SQL managed instance. string (required)
spec The specifications of the failover group resource. FailoverGroupSpec (required)
status The status of the failover group custom resource. any

FailoverGroupSpec

Name Description Value
partnerMI The name of the partner SQL managed instance. string
partnerMirroringCert The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. string
partnerMirroringURL The mirroring endpoint URL of the partner SQL managed instance. string
partnerSyncMode The partner sync mode of the SQL managed instance. 'async'
'sync'
role The role of the SQL managed instance in this failover group. 'force-primary-allow-data-loss'
'force-secondary'
'primary'
'secondary' (required)
sharedName The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. string
sourceMI The name of the SQL managed instance with this failover group role. string

Microsoft.AzureArcData/sqlManagedInstances/failoverGroups

Name Description Value
apiVersion The api version '2025-03-01-preview'
name The resource name string (required)
properties null FailoverGroupProperties (required)
type The resource type 'Microsoft.AzureArcData/sqlManagedInstances/failoverGroups'

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups@2025-03-01-preview"
  name = "string"
  body = {
    properties = {
      partnerManagedInstanceId = "string"
      spec = {
        partnerMI = "string"
        partnerMirroringCert = "string"
        partnerMirroringURL = "string"
        partnerSyncMode = "string"
        role = "string"
        sharedName = "string"
        sourceMI = "string"
      }
      status = ?
    }
  }
}

Property Values

FailoverGroupProperties

Name Description Value
partnerManagedInstanceId The resource ID of the partner SQL managed instance. string (required)
spec The specifications of the failover group resource. FailoverGroupSpec (required)
status The status of the failover group custom resource. any

FailoverGroupSpec

Name Description Value
partnerMI The name of the partner SQL managed instance. string
partnerMirroringCert The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. string
partnerMirroringURL The mirroring endpoint URL of the partner SQL managed instance. string
partnerSyncMode The partner sync mode of the SQL managed instance. 'async'
'sync'
role The role of the SQL managed instance in this failover group. 'force-primary-allow-data-loss'
'force-secondary'
'primary'
'secondary' (required)
sharedName The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. string
sourceMI The name of the SQL managed instance with this failover group role. string

Microsoft.AzureArcData/sqlManagedInstances/failoverGroups

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sqlManagedInstances
properties null FailoverGroupProperties (required)
type The resource type "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups@2025-03-01-preview"