Compartilhar via


Microsoft.Sql Servers/failoverGroups 2022-11-01-preview

Definição de recurso do Bicep

O tipo de recurso servers/failoverGroups pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Sql/servers/failoverGroups, adicione o Bicep a seguir ao seu modelo.

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

Valores de propriedade

Microsoft.Sql/servers/failoverGroups

Name Description Value
name O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: servidores
properties Propriedades do recurso. FailoverGroupProperties
tags Etiquetas de recursos Dicionário de nomes e valores de tags. Consulte Marcas em modelos

FailoverGroupProperties

Name Description Value
databases Lista de bancos de dados no grupo de failover. string[]
partnerServers Lista de informações do servidor parceiro para o grupo de failover. PartnerInfo[] (obrigatório)
readOnlyEndpoint Ponto de extremidade somente leitura da instância do grupo de failover. FailoverGroupReadOnlyEndpoint
readWriteEndpoint Ponto de extremidade de leitura/gravação da instância do grupo de failover. FailoverGroupReadWriteEndpoint (obrigatório)

FailoverGroupReadOnlyEndpoint

Name Description Value
failoverPolicy Política de failover do ponto de extremidade somente leitura para o grupo de failover. 'Disabled'
'Enabled'

FailoverGroupReadWriteEndpoint

Name Description Value
failoverPolicy Política de failover do ponto de extremidade de leitura/gravação para o grupo de failover. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário. 'Automatic'
'Manual' (obrigatório)
failoverWithDataLossGracePeriodMinutes Período de carência antes do failover com perda de dados é tentado para o ponto de extremidade de leitura/gravação. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário. int

FailoverGroupTags

Name Description Value

PartnerInfo

Name Description Value
id Identificador de recurso do servidor parceiro. cadeia de caracteres (obrigatório)

Definição de recurso de modelo do ARM

O tipo de recurso servers/failoverGroups pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Sql/servers/failoverGroups, adicione o JSON a seguir ao modelo.

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

Valores de propriedade

Microsoft.Sql/servers/failoverGroups

Name Description Value
apiVersion A versão da API '2022-11-01-preview'
name O nome do recurso cadeia de caracteres (obrigatório)
properties Propriedades do recurso. FailoverGroupProperties
tags Etiquetas de recursos Dicionário de nomes e valores de tags. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Sql/servers/failoverGroups'

FailoverGroupProperties

Name Description Value
databases Lista de bancos de dados no grupo de failover. string[]
partnerServers Lista de informações do servidor parceiro para o grupo de failover. PartnerInfo[] (obrigatório)
readOnlyEndpoint Ponto de extremidade somente leitura da instância do grupo de failover. FailoverGroupReadOnlyEndpoint
readWriteEndpoint Ponto de extremidade de leitura/gravação da instância do grupo de failover. FailoverGroupReadWriteEndpoint (obrigatório)

FailoverGroupReadOnlyEndpoint

Name Description Value
failoverPolicy Política de failover do ponto de extremidade somente leitura para o grupo de failover. 'Disabled'
'Enabled'

FailoverGroupReadWriteEndpoint

Name Description Value
failoverPolicy Política de failover do ponto de extremidade de leitura/gravação para o grupo de failover. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário. 'Automatic'
'Manual' (obrigatório)
failoverWithDataLossGracePeriodMinutes Período de carência antes do failover com perda de dados é tentado para o ponto de extremidade de leitura/gravação. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário. int

FailoverGroupTags

Name Description Value

PartnerInfo

Name Description Value
id Identificador de recurso do servidor parceiro. cadeia de caracteres (obrigatório)

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso servers/failoverGroups pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Sql/servers/failoverGroups, adicione o Terraform a seguir ao seu modelo.

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

Valores de propriedade

Microsoft.Sql/servers/failoverGroups

Name Description Value
name O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: servidores
properties Propriedades do recurso. FailoverGroupProperties
tags Etiquetas de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Sql/servers/failoverGroups@2022-11-01-preview"

FailoverGroupProperties

Name Description Value
databases Lista de bancos de dados no grupo de failover. string[]
partnerServers Lista de informações do servidor parceiro para o grupo de failover. PartnerInfo[] (obrigatório)
readOnlyEndpoint Ponto de extremidade somente leitura da instância do grupo de failover. FailoverGroupReadOnlyEndpoint
readWriteEndpoint Ponto de extremidade de leitura/gravação da instância do grupo de failover. FailoverGroupReadWriteEndpoint (obrigatório)

FailoverGroupReadOnlyEndpoint

Name Description Value
failoverPolicy Política de failover do ponto de extremidade somente leitura para o grupo de failover. 'Disabled'
'Enabled'

FailoverGroupReadWriteEndpoint

Name Description Value
failoverPolicy Política de failover do ponto de extremidade de leitura/gravação para o grupo de failover. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário. 'Automatic'
'Manual' (obrigatório)
failoverWithDataLossGracePeriodMinutes Período de carência antes do failover com perda de dados é tentado para o ponto de extremidade de leitura/gravação. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário. int

FailoverGroupTags

Name Description Value

PartnerInfo

Name Description Value
id Identificador de recurso do servidor parceiro. cadeia de caracteres (obrigatório)

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Grupo de Failover de SQL do 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
      }
    }
  }
}