Condividi tramite


Microsoft. Server/Gruppi di failover SQL 2025-01-01

Definizione della risorsa Bicep

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

  • Resource groups - Vedi resource group

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

Formato risorsa

Per creare un Microsoft. Risorsa Sql/servers/FailoverGroups, aggiungi il seguente Bicep al tuo template.

resource symbolicname 'Microsoft.Sql/servers/failoverGroups@2025-01-01' = {
  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/server/Gruppi di failover

Nome Descrizione Valore
nome Nome della risorsa stringa (obbligatorio)
parent In Bicep, puoi specificare la risorsa genitore per una risorsa figlia. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per ulteriori informazioni, vedi Risorsa figlio esterna risorsa genitore.
Nome simbolico per la risorsa di tipo: server
proprietà Proprietà delle risorse. FailoverGroupProperties
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedi tag nei template

FailoverGroupProperties

Nome Descrizione Valore
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

Nome Descrizione Valore
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

Nome Descrizione Valore
failoverPolicy Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes. 'Automatico'
'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

Nome Descrizione Valore

Informazioni sui partner

Nome Descrizione Valore
id Identificatore della risorsa del server partner. stringa (obbligatorio)

Esempi di utilizzo

Campioni di Bicep

Un esempio base di distribuzione del Microsoft Azure SQL Failover Group.

param resourceName string = 'acctest0001'
param location string = 'westus'
param secondaryLocation string = 'eastus'
@secure()
@description('The administrator login password for the SQL server')
param administratorLoginPassword string

resource server 'Microsoft.Sql/servers@2023-08-01-preview' = {
  name: '${resourceName}-primary'
  location: location
  properties: {
    administratorLogin: 'mradministrator'
    administratorLoginPassword: null
    minimalTlsVersion: '1.2'
    publicNetworkAccess: 'Enabled'
    restrictOutboundNetworkAccess: 'Disabled'
    version: '12.0'
  }
}

resource server1 'Microsoft.Sql/servers@2023-08-01-preview' = {
  name: '${resourceName}-secondary'
  properties: {
    administratorLogin: 'mradministrator'
    administratorLoginPassword: null
    minimalTlsVersion: '1.2'
    publicNetworkAccess: 'Enabled'
    restrictOutboundNetworkAccess: 'Disabled'
    version: '12.0'
  }
}

resource database 'Microsoft.Sql/servers/databases@2023-08-01-preview' = {
  parent: server
  name: '${resourceName}-db'
  location: location
  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 failoverGroup 'Microsoft.Sql/servers/failoverGroups@2023-08-01-preview' = {
  parent: server
  name: '${resourceName}-fg'
  properties: {
    databases: [
      database.id
    ]
    partnerServers: [
      {
        id: server1.id
      }
    ]
    readOnlyEndpoint: {
      failoverPolicy: 'Disabled'
    }
    readWriteEndpoint: {
      failoverPolicy: 'Automatic'
      failoverWithDataLossGracePeriodMinutes: 60
    }
  }
}

Definizione di risorsa del modello di Resource Manager

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

  • Resource groups - Vedi resource group

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

Formato risorsa

Per creare un Microsoft. Risorsa sql/servers/failoverGroups, aggiungi il seguente JSON al tuo template.

{
  "type": "Microsoft.Sql/servers/failoverGroups",
  "apiVersion": "2025-01-01",
  "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/server/Gruppi di failover

Nome Descrizione Valore
versione dell'API Versione dell'API '2025-01-01'
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà delle risorse. FailoverGroupProperties
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedi tag nei template
tipo Tipo di risorsa 'Microsoft. Sql/server/Gruppi di failover'

FailoverGroupProperties

Nome Descrizione Valore
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

Nome Descrizione Valore
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

Nome Descrizione Valore
failoverPolicy Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes. 'Automatico'
'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

Nome Descrizione Valore

Informazioni sui partner

Nome Descrizione Valore
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 un Microsoft. Risorsa SQL/servers/FailoverGroups, aggiungi il seguente Terraform al tuo template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/failoverGroups@2025-01-01"
  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/server/Gruppi di failover

Nome Descrizione Valore
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: server
proprietà Proprietà delle risorse. FailoverGroupProperties
tags Tag delle risorse Dizionario di nomi e valori di tag.
tipo Tipo di risorsa "Microsoft. Sql/server/failoverGroups@2025-01-01"

FailoverGroupProperties

Nome Descrizione Valore
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

Nome Descrizione Valore
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

Nome Descrizione Valore
failoverPolicy Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes. 'Automatico'
'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

Nome Descrizione Valore

Informazioni sui partner

Nome Descrizione Valore
id Identificatore della risorsa del server partner. stringa (obbligatorio)

Esempi di utilizzo

Esempi di Terraform

Un esempio base di distribuzione del Microsoft Azure SQL Failover Group.

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
      }
    }
  }
}