Microsoft.DBforPostgreSQL serverGroupsv2

Artigo
12/09/2024

Definição de recursos do bíceps

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

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

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

Formato do recurso

Para criar um recurso Microsoft.DBforPostgreSQL/serverGroupsv2, adicione o seguinte Bicep ao seu 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

AuthConfig

Designação	Descrição	Valor
activeDirectoryAuth		'deficientes' 'habilitado'
passwordAuth		'deficientes' 'habilitado'

ClusterProperties

Designação	Descrição	Valor
administradorLoginPassword	A senha do login de administrador. Necessário para a criação.	string Restrições: Valor sensível. Passe como um parâmetro seguro.
authConfig	Configuração de autenticação de um cluster.	AuthConfig
citusVersão	A versão da extensão Citus em todos os servidores de cluster.	string
coordenadorEnablePublicIpAccess	Se o acesso público estiver habilitado no coordenador.	Bool
coordenadorServerEdition	A edição de um servidor coordenador (padrão: GeneralPurpose). Necessário para a criação.	string
coordenadorStorageQuotaInMb	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áx: 96). Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações.	Int
Nome do banco de dados	O nome do banco de dados do cluster. Há suporte para apenas um banco de dados por cluster.	string
encriptação de dados	As propriedades de criptografia de dados de um cluster.	DataEncryption
habilitarGeoBackup	Se o backup de cluster estiver armazenado em outra região do Azure, além da cópia do backup armazenada 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 são colocadas no coordenador ou não. Deve ser definido como 'true' em clusters de nó único. Requer rebalanceamento de estilhaço 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ó. 2 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 nos nós de trabalho.	Bool
nodeServerEdition [en]	A edição de um servidor de nó (padrão: MemoryOptimized).	string
nodeStorageQuotaInMb	O armazenamento em MB em cada nó de trabalho. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações.	Int
nodeVCores	O cálculo em vCores em cada nó de trabalho (máx: 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 do cluster.	string
postgresqlVersão	A versão principal do PostgreSQL em todos os servidores de cluster.	string
preferredPrimaryZone	Zona de disponibilidade primária (AZ) preferencial para todos os servidores de cluster.	string
fonteLocalização	A região do Azure do cluster de origem para clusters de réplica de leitura.	string
sourceResourceId	A id de recurso do cluster de origem para clusters de réplica de leitura.	string

Encriptação de Dados

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

IdentityProperties

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

Janela de Manutenção

Designação	Descrição	Valor
customWindow	Indica se a janela de manutenção personalizada está habilitada ou não.	string
diadesemana	Dia preferido da semana para a janela de manutenção.	Int
hora de início	Hora de início dentro do dia preferido da semana para a janela de manutenção.	Int
Minuto inicial	Minuto de início dentro da hora de início para a janela de manutenção.	Int

Microsoft.DBforPostgreSQL/serverGroupsv2

Designação	Descrição	Valor
identidade	Descreve a identidade do cluster.	IdentityProperties
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 Padrão = `^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$` (obrigatório)
propriedades	Propriedades do cluster.	ClusterProperties
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

TrackedResourceTags

Designação	Descrição	Valor

UserAssignedIdentities

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

Definição de recurso de modelo ARM

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

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

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

Formato do recurso

Para criar um recurso Microsoft.DBforPostgreSQL/serverGroupsv2, adicione o seguinte JSON ao seu 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

AuthConfig

Designação	Descrição	Valor
activeDirectoryAuth		'deficientes' 'habilitado'
passwordAuth		'deficientes' 'habilitado'

ClusterProperties

Designação	Descrição	Valor
administradorLoginPassword	A senha do login de administrador. Necessário para a criação.	string Restrições: Valor sensível. Passe como um parâmetro seguro.
authConfig	Configuração de autenticação de um cluster.	AuthConfig
citusVersão	A versão da extensão Citus em todos os servidores de cluster.	string
coordenadorEnablePublicIpAccess	Se o acesso público estiver habilitado no coordenador.	Bool
coordenadorServerEdition	A edição de um servidor coordenador (padrão: GeneralPurpose). Necessário para a criação.	string
coordenadorStorageQuotaInMb	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áx: 96). Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações.	Int
Nome do banco de dados	O nome do banco de dados do cluster. Há suporte para apenas um banco de dados por cluster.	string
encriptação de dados	As propriedades de criptografia de dados de um cluster.	DataEncryption
habilitarGeoBackup	Se o backup de cluster estiver armazenado em outra região do Azure, além da cópia do backup armazenada 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 são colocadas no coordenador ou não. Deve ser definido como 'true' em clusters de nó único. Requer rebalanceamento de estilhaço 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ó. 2 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 nos nós de trabalho.	Bool
nodeServerEdition [en]	A edição de um servidor de nó (padrão: MemoryOptimized).	string
nodeStorageQuotaInMb	O armazenamento em MB em cada nó de trabalho. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações.	Int
nodeVCores	O cálculo em vCores em cada nó de trabalho (máx: 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 do cluster.	string
postgresqlVersão	A versão principal do PostgreSQL em todos os servidores de cluster.	string
preferredPrimaryZone	Zona de disponibilidade primária (AZ) preferencial para todos os servidores de cluster.	string
fonteLocalização	A região do Azure do cluster de origem para clusters de réplica de leitura.	string
sourceResourceId	A id de recurso do cluster de origem para clusters de réplica de leitura.	string

Encriptação de Dados

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

IdentityProperties

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

Janela de Manutenção

Designação	Descrição	Valor
customWindow	Indica se a janela de manutenção personalizada está habilitada ou não.	string
diadesemana	Dia preferido da semana para a janela de manutenção.	Int
hora de início	Hora de início dentro do dia preferido da semana para a janela de manutenção.	Int
Minuto inicial	Minuto de início dentro da hora de início para a janela de manutenção.	Int

Microsoft.DBforPostgreSQL/serverGroupsv2

Designação	Descrição	Valor
apiVersion	A versão api	'2023-03-02-pré-visualização'
identidade	Descreve a identidade do cluster.	IdentityProperties
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 Padrão = `^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$` (obrigatório)
propriedades	Propriedades do cluster.	ClusterProperties
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de recurso	'Microsoft.DBforPostgreSQL/serverGroupsv2'

TrackedResourceTags

Designação	Descrição	Valor

UserAssignedIdentities

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

Definição de recursos Terraform (provedor AzAPI)

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

Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.DBforPostgreSQL/serverGroupsv2, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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

AuthConfig

Designação	Descrição	Valor
activeDirectoryAuth		'deficientes' 'habilitado'
passwordAuth		'deficientes' 'habilitado'

ClusterProperties

Designação	Descrição	Valor
administradorLoginPassword	A senha do login de administrador. Necessário para a criação.	string Restrições: Valor sensível. Passe como um parâmetro seguro.
authConfig	Configuração de autenticação de um cluster.	AuthConfig
citusVersão	A versão da extensão Citus em todos os servidores de cluster.	string
coordenadorEnablePublicIpAccess	Se o acesso público estiver habilitado no coordenador.	Bool
coordenadorServerEdition	A edição de um servidor coordenador (padrão: GeneralPurpose). Necessário para a criação.	string
coordenadorStorageQuotaInMb	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áx: 96). Necessário para a criação. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações.	Int
Nome do banco de dados	O nome do banco de dados do cluster. Há suporte para apenas um banco de dados por cluster.	string
encriptação de dados	As propriedades de criptografia de dados de um cluster.	DataEncryption
habilitarGeoBackup	Se o backup de cluster estiver armazenado em outra região do Azure, além da cópia do backup armazenada 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 são colocadas no coordenador ou não. Deve ser definido como 'true' em clusters de nó único. Requer rebalanceamento de estilhaço 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ó. 2 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 nos nós de trabalho.	Bool
nodeServerEdition [en]	A edição de um servidor de nó (padrão: MemoryOptimized).	string
nodeStorageQuotaInMb	O armazenamento em MB em cada nó de trabalho. Consulte /azure/cosmos-db/postgresql/resources-compute para obter mais informações.	Int
nodeVCores	O cálculo em vCores em cada nó de trabalho (máx: 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 do cluster.	string
postgresqlVersão	A versão principal do PostgreSQL em todos os servidores de cluster.	string
preferredPrimaryZone	Zona de disponibilidade primária (AZ) preferencial para todos os servidores de cluster.	string
fonteLocalização	A região do Azure do cluster de origem para clusters de réplica de leitura.	string
sourceResourceId	A id de recurso do cluster de origem para clusters de réplica de leitura.	string

Encriptação de Dados

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

IdentityProperties

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

Janela de Manutenção

Designação	Descrição	Valor
customWindow	Indica se a janela de manutenção personalizada está habilitada ou não.	string
diadesemana	Dia preferido da semana para a janela de manutenção.	Int
hora de início	Hora de início dentro do dia preferido da semana para a janela de manutenção.	Int
Minuto inicial	Minuto de início dentro da hora de início para a janela de manutenção.	Int

Microsoft.DBforPostgreSQL/serverGroupsv2

Designação	Descrição	Valor
identidade	Descreve a identidade do cluster.	IdentityProperties
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 Padrão = `^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$` (obrigatório)
propriedades	Propriedades do cluster.	ClusterProperties
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"

TrackedResourceTags

Designação	Descrição	Valor

UserAssignedIdentities

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

Partilhar via

Microsoft.DBforPostgreSQL serverGroupsv2

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

AuthConfig

ClusterProperties

Encriptação de Dados

IdentityProperties

Janela de Manutenção

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

AuthConfig

ClusterProperties

Encriptação de Dados

IdentityProperties

Janela de Manutenção

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

AuthConfig

ClusterProperties

Encriptação de Dados

IdentityProperties

Janela de Manutenção

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Comentários

Recursos adicionais