Microsoft.Sql server/failoverGroups

• Latest
• 2024-11-01-preview
• 2024-05-01-preview
• 2023-08-01
• 2023-08-01-preview
• 2023-05-01-preview
• 2023-02-01-preview
• 2022-11-01-preview
• 2022-08-01-preview
• 2022-05-01-preview
• 2022-02-01-preview
• 2021-11-01
• 2021-11-01-preview
• 2021-08-01-preview
• 2021-05-01-preview
• 2021-02-01-preview
• 2020-11-01-preview
• 2020-08-01-preview
• 2020-02-02-preview
• 2015-05-01-preview

Definizione di risorsa Bicep

Il tipo di risorsa servers/failoverGroups può essere distribuito con operazioni destinate a:

• gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Sql/servers/failoverGroups, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Sql/servers/failoverGroups@2024-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    databases: [
      'string'
    ]
    partnerServers: [
      {
        id: 'string'
      }
    ]
    readOnlyEndpoint: {
      failoverPolicy: 'string'
      targetServer: 'string'
    }
    readWriteEndpoint: {
      failoverPolicy: 'string'
      failoverWithDataLossGracePeriodMinutes: int
    }
    secondaryType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

Microsoft.Sql/servers/failoverGroups

Name	Description	Value
name	Nome della risorsa	stringa (obbligatorio)
parent	In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.	Nome simbolico per la risorsa di tipo: server
properties	Proprietà delle risorse.	FailoverGroupProperties
tags	Tag delle risorse	Dizionario di nomi e valori di tag. Vedere tag nei modelli

FailoverGroupProperties

Name	Description	Value
databases	Elenco di database nel gruppo di failover.	string[]
partnerServers	Elenco delle informazioni sul server partner per il gruppo di failover.	PartnerInfo[] (obbligatorio)
readOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.	FailoverGroupReadOnlyEndpoint
readWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.	FailoverGroupReadWriteEndpoint (obbligatorio)
secondaryType	Tipo secondario di database nel server partner.	'Geo' 'Standby'

FailoverGroupReadOnlyEndpoint

Name	Description	Value
failoverPolicy	Criteri di failover dell'endpoint di sola lettura per il gruppo di failover.	'Disabled' 'Enabled'
targetServer	Server partner di destinazione in cui punta l'endpoint di sola lettura.	string

FailoverGroupReadWriteEndpoint

Name	Description	Value
failoverPolicy	Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.	'Automatic' 'Manuale' (obbligatorio)
failoverWithDataLossGracePeriodMinutes	Periodo di tolleranza prima del tentativo di failover con perdita di dati per l'endpoint di lettura/scrittura. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.	int

FailoverGroupTags

Name	Description	Value

PartnerInfo

Name	Description	Value
id	Identificatore della risorsa del server partner.	stringa (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa servers/failoverGroups può essere distribuito con operazioni destinate a:

• gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Sql/servers/failoverGroups, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Sql/servers/failoverGroups",
  "apiVersion": "2024-11-01-preview",
  "name": "string",
  "properties": {
    "databases": [ "string" ],
    "partnerServers": [
      {
        "id": "string"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "string",
      "targetServer": "string"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "string",
      "failoverWithDataLossGracePeriodMinutes": "int"
    },
    "secondaryType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

Microsoft.Sql/servers/failoverGroups

Name	Description	Value
apiVersion	Versione dell'API	'2024-11-01-preview'
name	Nome della risorsa	stringa (obbligatorio)
properties	Proprietà delle risorse.	FailoverGroupProperties
tags	Tag delle risorse	Dizionario di nomi e valori di tag. Vedere tag nei modelli
type	Tipo di risorsa	'Microsoft.Sql/servers/failoverGroups'

FailoverGroupProperties

Name	Description	Value
databases	Elenco di database nel gruppo di failover.	string[]
partnerServers	Elenco delle informazioni sul server partner per il gruppo di failover.	PartnerInfo[] (obbligatorio)
readOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.	FailoverGroupReadOnlyEndpoint
readWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.	FailoverGroupReadWriteEndpoint (obbligatorio)
secondaryType	Tipo secondario di database nel server partner.	'Geo' 'Standby'

FailoverGroupReadOnlyEndpoint

Name	Description	Value
failoverPolicy	Criteri di failover dell'endpoint di sola lettura per il gruppo di failover.	'Disabled' 'Enabled'
targetServer	Server partner di destinazione in cui punta l'endpoint di sola lettura.	string

FailoverGroupReadWriteEndpoint

Name	Description	Value
failoverPolicy	Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.	'Automatic' 'Manuale' (obbligatorio)
failoverWithDataLossGracePeriodMinutes	Periodo di tolleranza prima del tentativo di failover con perdita di dati per l'endpoint di lettura/scrittura. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.	int

FailoverGroupTags

Name	Description	Value

PartnerInfo

Name	Description	Value
id	Identificatore della risorsa del server partner.	stringa (obbligatorio)

Esempi di utilizzo

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa servers/failoverGroups può essere distribuito con operazioni destinate a:

• Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Sql/servers/failoverGroups, aggiungere il file Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/failoverGroups@2024-11-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      databases = [
        "string"
      ]
      partnerServers = [
        {
          id = "string"
        }
      ]
      readOnlyEndpoint = {
        failoverPolicy = "string"
        targetServer = "string"
      }
      readWriteEndpoint = {
        failoverPolicy = "string"
        failoverWithDataLossGracePeriodMinutes = int
      }
      secondaryType = "string"
    }
  }
}

Valori delle proprietà

Microsoft.Sql/servers/failoverGroups

Name	Description	Value
name	Nome della risorsa	stringa (obbligatorio)
parent_id	ID della risorsa padre per questa risorsa.	ID per la risorsa di tipo: server
properties	Proprietà delle risorse.	FailoverGroupProperties
tags	Tag delle risorse	Dizionario di nomi e valori di tag.
type	Tipo di risorsa	"Microsoft.Sql/servers/failoverGroups@2024-11-01-preview"

FailoverGroupProperties

Name	Description	Value
databases	Elenco di database nel gruppo di failover.	string[]
partnerServers	Elenco delle informazioni sul server partner per il gruppo di failover.	PartnerInfo[] (obbligatorio)
readOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.	FailoverGroupReadOnlyEndpoint
readWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.	FailoverGroupReadWriteEndpoint (obbligatorio)
secondaryType	Tipo secondario di database nel server partner.	'Geo' 'Standby'

FailoverGroupReadOnlyEndpoint

Name	Description	Value
failoverPolicy	Criteri di failover dell'endpoint di sola lettura per il gruppo di failover.	'Disabled' 'Enabled'
targetServer	Server partner di destinazione in cui punta l'endpoint di sola lettura.	string

FailoverGroupReadWriteEndpoint

Name	Description	Value
failoverPolicy	Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.	'Automatic' 'Manuale' (obbligatorio)
failoverWithDataLossGracePeriodMinutes	Periodo di tolleranza prima del tentativo di failover con perdita di dati per l'endpoint di lettura/scrittura. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.	int

FailoverGroupTags

Name	Description	Value

PartnerInfo

Name	Description	Value
id	Identificatore della risorsa del server partner.	stringa (obbligatorio)

Esempi di utilizzo

Esempi di Terraform

Esempio di base di distribuzione del gruppo di failover SQL di Microsoft Azure.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

data "azapi_client_config" "current" {}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

variable "secondary_location" {
  type    = string
  default = "eastus"
}

variable "administrator_login_password" {
  type        = string
  sensitive   = true
  description = "The administrator login password for the SQL server"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "server" {
  type      = "Microsoft.Sql/servers@2023-08-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-primary"
  location  = var.location
  body = {
    properties = {
      administratorLogin            = "mradministrator"
      administratorLoginPassword    = var.administrator_login_password
      minimalTlsVersion             = "1.2"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      version                       = "12.0"
    }
  }
}

resource "azapi_resource" "server_1" {
  type      = "Microsoft.Sql/servers@2023-08-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-secondary"
  location  = var.secondary_location
  body = {
    properties = {
      administratorLogin            = "mradministrator"
      administratorLoginPassword    = var.administrator_login_password
      minimalTlsVersion             = "1.2"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      version                       = "12.0"
    }
  }
}

resource "azapi_resource" "database" {
  type      = "Microsoft.Sql/servers/databases@2023-08-01-preview"
  parent_id = azapi_resource.server.id
  name      = "${var.resource_name}-db"
  location  = var.location
  body = {
    properties = {
      autoPauseDelay                   = 0
      collation                        = "SQL_Latin1_General_CP1_CI_AS"
      createMode                       = "Default"
      elasticPoolId                    = ""
      encryptionProtectorAutoRotation  = false
      highAvailabilityReplicaCount     = 0
      isLedgerOn                       = false
      licenseType                      = ""
      maxSizeBytes                     = 214748364800
      minCapacity                      = 0
      readScale                        = "Disabled"
      requestedBackupStorageRedundancy = "Geo"
      sampleName                       = ""
      secondaryType                    = ""
      zoneRedundant                    = false
    }
    sku = {
      name = "S1"
    }
  }
}

resource "azapi_resource" "failoverGroup" {
  type      = "Microsoft.Sql/servers/failoverGroups@2023-08-01-preview"
  parent_id = azapi_resource.server.id
  name      = "${var.resource_name}-fg"
  body = {
    properties = {
      databases = [azapi_resource.database.id]
      partnerServers = [{
        id = azapi_resource.server_1.id
      }]
      readOnlyEndpoint = {
        failoverPolicy = "Disabled"
      }
      readWriteEndpoint = {
        failoverPolicy                         = "Automatic"
        failoverWithDataLossGracePeriodMinutes = 60
      }
    }
  }
}