Microsoft.DBforPostgreSQL serverGroupsv2

Definição de recurso do Bicep

O tipo de recurso serverGroupsv2 pode ser implantado com operações de destino:

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.DBforPostgreSQL/serverGroupsv2, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    administratorLoginPassword: 'string'
    authConfig: {
      activeDirectoryAuth: 'string'
      passwordAuth: 'string'
    }
    citusVersion: 'string'
    coordinatorEnablePublicIpAccess: bool
    coordinatorServerEdition: 'string'
    coordinatorStorageQuotaInMb: int
    coordinatorVCores: int
    databaseName: 'string'
    dataEncryption: {
      primaryKeyUri: 'string'
      primaryUserAssignedIdentityId: 'string'
      type: 'string'
    }
    enableGeoBackup: bool
    enableHa: bool
    enableShardsOnCoordinator: bool
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    nodeCount: int
    nodeEnablePublicIpAccess: bool
    nodeServerEdition: 'string'
    nodeStorageQuotaInMb: int
    nodeVCores: int
    pointInTimeUTC: 'string'
    postgresqlVersion: 'string'
    preferredPrimaryZone: 'string'
    sourceLocation: 'string'
    sourceResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.DBforPostgreSQL/serverGroupsv2

Nome Descrição Valor
identidade Descreve a identidade do cluster. IdentityProperties
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 40
Padrão = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obrigatório)
Propriedades Propriedades do cluster. clusterProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

AuthConfig

Nome Descrição Valor
activeDirectoryAuth 'desabilitado'
'habilitado'
passwordAuth 'desabilitado'
'habilitado'

Propriedades do Cluster

Nome Descrição Valor
administratorLoginPassword A senha do logon do administrador. Necessário para a criação. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
authConfig Configuração de autenticação de um cluster. AuthConfig
citusVersion A versão da extensão citus em todos os servidores de cluster. cadeia
coordinatorEnablePublicIpAccess Se o acesso público estiver habilitado no coordenador. Bool
coordinatorServerEdition A edição de um servidor coordenador (padrão: GeneralPurpose). Necessário para a criação. cadeia
coordinatorStorageQuotaInMb O armazenamento de um servidor em MB. Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
coordenadorVCores A contagem de vCores de um servidor (máximo: 96). Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
nomeDoBancoDeDados O nome do banco de dados do cluster. Há suporte para apenas um banco de dados por cluster. cadeia
criptografia de dados As propriedades de criptografia de dados de um cluster. Criptografia de dados
ativarGeoBackup Se o backup de cluster for armazenado em outra região do Azure, além da cópia do backup armazenado na região do cluster. Habilitado somente no momento da criação do cluster. Bool
habilitarHa Se a ALTA DISPONIBILIDADE (HA) estiver habilitada ou não para o cluster. Bool
enableShardsOnCoordinator Se as tabelas distribuídas forem colocadas no coordenador ou não. Deve ser definido como 'true' em clusters de nó único. Requer o rebalanceamento de fragmentos depois que o valor é alterado. Bool
manutençãoJanela Janela de manutenção de um cluster. MaintenanceWindow
nodeCount Contagem de nós de trabalho do cluster. Quando a contagem de nós é 0, ela representa uma configuração de nó único com a capacidade de criar tabelas distribuídas nesse nó. Dois ou mais nós de trabalho representam a configuração de vários nós. O valor da contagem de nós não pode ser 1. Necessário para a criação. int
nodeEnablePublicIpAccess Se o acesso público estiver habilitado em nós de trabalho. Bool
nodeServerEdition A edição de um servidor de nó (padrão: MemoryOptimized). cadeia
nodeStorageQuotaInMb O armazenamento em MB em cada nó de trabalho. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
nodeVCores A computação em vCores em cada nó de trabalho (máximo: 104). Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
pointInTimeUTC Data e hora em UTC (formato ISO8601) para restauração de cluster. cadeia
PostgresqlVersion A versão principal do PostgreSQL em todos os servidores de cluster. cadeia
preferredPrimaryZone Zona de disponibilidade primária preferencial (AZ) para todos os servidores de cluster. cadeia
localizaçãoFonte A região do Azure do cluster de origem para clusters de réplica de leitura. cadeia
sourceResourceId A ID do recurso do cluster de origem para clusters de réplica de leitura. cadeia

Criptografia de dados

Nome Descrição Valor
primárioKeyUri URI da chave no keyvault para criptografia de dados do servidor primário. cadeia
primárioUserAssignedIdentityId ID de recurso para a identidade atribuída pelo usuário a ser usada para criptografia de dados do servidor primário. cadeia
tipo 'AzureKeyVault'
'SystemAssigned'

Propriedades de Identidade

Nome Descrição Valor
tipo 'SystemAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Nome Descrição Valor

Janela de manutenção

Nome Descrição Valor
customWindow Indica se a janela de manutenção personalizada está habilitada ou não. cadeia
diaDeSemana Dia preferencial da semana para a janela de manutenção. int
hora inicial Hora de início no dia preferencial da semana para a janela de manutenção. int
Minuto inicial Minuto de início dentro da hora de início da janela de manutenção. int

TrackedResourceTags

Nome Descrição Valor

UserAssignedIdentity

Nome Descrição Valor

Exemplos de uso

Exemplos do Bicep

Um exemplo básico de implantação do Cluster do Azure Cosmos DB for PostgreSQL.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The administrator login password for the PostgreSQL server group')
param administratorLoginPassword string

resource serverGroupsv2 'Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08' = {
  name: resourceName
  location: location
  properties: {
    administratorLoginPassword: null
    coordinatorEnablePublicIpAccess: true
    coordinatorServerEdition: 'GeneralPurpose'
    coordinatorStorageQuotaInMb: 131072
    coordinatorVCores: 2
    enableHa: false
    nodeCount: 0
    nodeEnablePublicIpAccess: false
    nodeServerEdition: 'MemoryOptimized'
  }
}

Definição de recurso de modelo do ARM

O tipo de recurso serverGroupsv2 pode ser implantado com operações de destino:

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.DBforPostgreSQL/serverGroupsv2, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "apiVersion": "2023-03-02-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "administratorLoginPassword": "string",
    "authConfig": {
      "activeDirectoryAuth": "string",
      "passwordAuth": "string"
    },
    "citusVersion": "string",
    "coordinatorEnablePublicIpAccess": "bool",
    "coordinatorServerEdition": "string",
    "coordinatorStorageQuotaInMb": "int",
    "coordinatorVCores": "int",
    "databaseName": "string",
    "dataEncryption": {
      "primaryKeyUri": "string",
      "primaryUserAssignedIdentityId": "string",
      "type": "string"
    },
    "enableGeoBackup": "bool",
    "enableHa": "bool",
    "enableShardsOnCoordinator": "bool",
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "nodeCount": "int",
    "nodeEnablePublicIpAccess": "bool",
    "nodeServerEdition": "string",
    "nodeStorageQuotaInMb": "int",
    "nodeVCores": "int",
    "pointInTimeUTC": "string",
    "postgresqlVersion": "string",
    "preferredPrimaryZone": "string",
    "sourceLocation": "string",
    "sourceResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.DBforPostgreSQL/serverGroupsv2

Nome Descrição Valor
apiVersion A versão da API '2023-03-02-preview'
identidade Descreve a identidade do cluster. IdentityProperties
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 40
Padrão = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obrigatório)
Propriedades Propriedades do cluster. clusterProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DBforPostgreSQL/serverGroupsv2'

AuthConfig

Nome Descrição Valor
activeDirectoryAuth 'desabilitado'
'habilitado'
passwordAuth 'desabilitado'
'habilitado'

Propriedades do Cluster

Nome Descrição Valor
administratorLoginPassword A senha do logon do administrador. Necessário para a criação. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
authConfig Configuração de autenticação de um cluster. AuthConfig
citusVersion A versão da extensão citus em todos os servidores de cluster. cadeia
coordinatorEnablePublicIpAccess Se o acesso público estiver habilitado no coordenador. Bool
coordinatorServerEdition A edição de um servidor coordenador (padrão: GeneralPurpose). Necessário para a criação. cadeia
coordinatorStorageQuotaInMb O armazenamento de um servidor em MB. Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
coordenadorVCores A contagem de vCores de um servidor (máximo: 96). Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
nomeDoBancoDeDados O nome do banco de dados do cluster. Há suporte para apenas um banco de dados por cluster. cadeia
criptografia de dados As propriedades de criptografia de dados de um cluster. Criptografia de dados
ativarGeoBackup Se o backup de cluster for armazenado em outra região do Azure, além da cópia do backup armazenado na região do cluster. Habilitado somente no momento da criação do cluster. Bool
habilitarHa Se a ALTA DISPONIBILIDADE (HA) estiver habilitada ou não para o cluster. Bool
enableShardsOnCoordinator Se as tabelas distribuídas forem colocadas no coordenador ou não. Deve ser definido como 'true' em clusters de nó único. Requer o rebalanceamento de fragmentos depois que o valor é alterado. Bool
manutençãoJanela Janela de manutenção de um cluster. MaintenanceWindow
nodeCount Contagem de nós de trabalho do cluster. Quando a contagem de nós é 0, ela representa uma configuração de nó único com a capacidade de criar tabelas distribuídas nesse nó. Dois ou mais nós de trabalho representam a configuração de vários nós. O valor da contagem de nós não pode ser 1. Necessário para a criação. int
nodeEnablePublicIpAccess Se o acesso público estiver habilitado em nós de trabalho. Bool
nodeServerEdition A edição de um servidor de nó (padrão: MemoryOptimized). cadeia
nodeStorageQuotaInMb O armazenamento em MB em cada nó de trabalho. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
nodeVCores A computação em vCores em cada nó de trabalho (máximo: 104). Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
pointInTimeUTC Data e hora em UTC (formato ISO8601) para restauração de cluster. cadeia
PostgresqlVersion A versão principal do PostgreSQL em todos os servidores de cluster. cadeia
preferredPrimaryZone Zona de disponibilidade primária preferencial (AZ) para todos os servidores de cluster. cadeia
localizaçãoFonte A região do Azure do cluster de origem para clusters de réplica de leitura. cadeia
sourceResourceId A ID do recurso do cluster de origem para clusters de réplica de leitura. cadeia

Criptografia de dados

Nome Descrição Valor
primárioKeyUri URI da chave no keyvault para criptografia de dados do servidor primário. cadeia
primárioUserAssignedIdentityId ID de recurso para a identidade atribuída pelo usuário a ser usada para criptografia de dados do servidor primário. cadeia
tipo 'AzureKeyVault'
'SystemAssigned'

Propriedades de Identidade

Nome Descrição Valor
tipo 'SystemAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Nome Descrição Valor

Janela de manutenção

Nome Descrição Valor
customWindow Indica se a janela de manutenção personalizada está habilitada ou não. cadeia
diaDeSemana Dia preferencial da semana para a janela de manutenção. int
hora inicial Hora de início no dia preferencial da semana para a janela de manutenção. int
Minuto inicial Minuto de início dentro da hora de início da janela de manutenção. int

TrackedResourceTags

Nome Descrição Valor

UserAssignedIdentity

Nome Descrição Valor

Exemplos de uso

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

O tipo de recurso serverGroupsv2 pode ser implantado com operações de destino:

  • Grupos de recursos

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.DBforPostgreSQL/serverGroupsv2, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      administratorLoginPassword = "string"
      authConfig = {
        activeDirectoryAuth = "string"
        passwordAuth = "string"
      }
      citusVersion = "string"
      coordinatorEnablePublicIpAccess = bool
      coordinatorServerEdition = "string"
      coordinatorStorageQuotaInMb = int
      coordinatorVCores = int
      databaseName = "string"
      dataEncryption = {
        primaryKeyUri = "string"
        primaryUserAssignedIdentityId = "string"
        type = "string"
      }
      enableGeoBackup = bool
      enableHa = bool
      enableShardsOnCoordinator = bool
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      nodeCount = int
      nodeEnablePublicIpAccess = bool
      nodeServerEdition = "string"
      nodeStorageQuotaInMb = int
      nodeVCores = int
      pointInTimeUTC = "string"
      postgresqlVersion = "string"
      preferredPrimaryZone = "string"
      sourceLocation = "string"
      sourceResourceId = "string"
    }
  }
}

Valores de propriedade

Microsoft.DBforPostgreSQL/serverGroupsv2

Nome Descrição Valor
identidade Descreve a identidade do cluster. IdentityProperties
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 40
Padrão = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obrigatório)
Propriedades Propriedades do cluster. clusterProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"

AuthConfig

Nome Descrição Valor
activeDirectoryAuth 'desabilitado'
'habilitado'
passwordAuth 'desabilitado'
'habilitado'

Propriedades do Cluster

Nome Descrição Valor
administratorLoginPassword A senha do logon do administrador. Necessário para a criação. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
authConfig Configuração de autenticação de um cluster. AuthConfig
citusVersion A versão da extensão citus em todos os servidores de cluster. cadeia
coordinatorEnablePublicIpAccess Se o acesso público estiver habilitado no coordenador. Bool
coordinatorServerEdition A edição de um servidor coordenador (padrão: GeneralPurpose). Necessário para a criação. cadeia
coordinatorStorageQuotaInMb O armazenamento de um servidor em MB. Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
coordenadorVCores A contagem de vCores de um servidor (máximo: 96). Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
nomeDoBancoDeDados O nome do banco de dados do cluster. Há suporte para apenas um banco de dados por cluster. cadeia
criptografia de dados As propriedades de criptografia de dados de um cluster. Criptografia de dados
ativarGeoBackup Se o backup de cluster for armazenado em outra região do Azure, além da cópia do backup armazenado na região do cluster. Habilitado somente no momento da criação do cluster. Bool
habilitarHa Se a ALTA DISPONIBILIDADE (HA) estiver habilitada ou não para o cluster. Bool
enableShardsOnCoordinator Se as tabelas distribuídas forem colocadas no coordenador ou não. Deve ser definido como 'true' em clusters de nó único. Requer o rebalanceamento de fragmentos depois que o valor é alterado. Bool
manutençãoJanela Janela de manutenção de um cluster. MaintenanceWindow
nodeCount Contagem de nós de trabalho do cluster. Quando a contagem de nós é 0, ela representa uma configuração de nó único com a capacidade de criar tabelas distribuídas nesse nó. Dois ou mais nós de trabalho representam a configuração de vários nós. O valor da contagem de nós não pode ser 1. Necessário para a criação. int
nodeEnablePublicIpAccess Se o acesso público estiver habilitado em nós de trabalho. Bool
nodeServerEdition A edição de um servidor de nó (padrão: MemoryOptimized). cadeia
nodeStorageQuotaInMb O armazenamento em MB em cada nó de trabalho. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
nodeVCores A computação em vCores em cada nó de trabalho (máximo: 104). Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações. int
pointInTimeUTC Data e hora em UTC (formato ISO8601) para restauração de cluster. cadeia
PostgresqlVersion A versão principal do PostgreSQL em todos os servidores de cluster. cadeia
preferredPrimaryZone Zona de disponibilidade primária preferencial (AZ) para todos os servidores de cluster. cadeia
localizaçãoFonte A região do Azure do cluster de origem para clusters de réplica de leitura. cadeia
sourceResourceId A ID do recurso do cluster de origem para clusters de réplica de leitura. cadeia

Criptografia de dados

Nome Descrição Valor
primárioKeyUri URI da chave no keyvault para criptografia de dados do servidor primário. cadeia
primárioUserAssignedIdentityId ID de recurso para a identidade atribuída pelo usuário a ser usada para criptografia de dados do servidor primário. cadeia
tipo 'AzureKeyVault'
'SystemAssigned'

Propriedades de Identidade

Nome Descrição Valor
tipo 'SystemAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Nome Descrição Valor

Janela de manutenção

Nome Descrição Valor
customWindow Indica se a janela de manutenção personalizada está habilitada ou não. cadeia
diaDeSemana Dia preferencial da semana para a janela de manutenção. int
hora inicial Hora de início no dia preferencial da semana para a janela de manutenção. int
Minuto inicial Minuto de início dentro da hora de início da janela de manutenção. int

TrackedResourceTags

Nome Descrição Valor

UserAssignedIdentity

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Cluster do Azure Cosmos DB for PostgreSQL.

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

provider "azapi" {
  skip_provider_registration = false
}

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

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

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

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

resource "azapi_resource" "serverGroupsv2" {
  type      = "Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      administratorLoginPassword      = var.administrator_login_password
      coordinatorEnablePublicIpAccess = true
      coordinatorServerEdition        = "GeneralPurpose"
      coordinatorStorageQuotaInMb     = 131072
      coordinatorVCores               = 2
      enableHa                        = false
      nodeCount                       = 0
      nodeEnablePublicIpAccess        = false
      nodeServerEdition               = "MemoryOptimized"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}