Servidor Microsoft.DBforPostgreSQLGroupsv2

Definición de recursos de Bicep

El tipo de recurso serverGroupsv2 se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DBforPostgreSQL/serverGroupsv2, agregue el siguiente bicep a la plantilla.

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 propiedad

Microsoft.DBforPostgreSQL/serverGroupsv2

Nombre Descripción Valor
identidad Describe la identidad del clúster. IdentityProperties
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 40
Patrón = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obligatorio)
Propiedades Propiedades del clúster. clusterProperties de
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

AuthConfig

Nombre Descripción Valor
activeDirectoryAuth 'Desactivado'
'habilitado'
passwordAuth 'Desactivado'
'habilitado'

ClusterProperties (Propiedades de clúster)

Nombre Descripción Valor
administratorLoginPassword Contraseña del inicio de sesión del administrador. Necesario para la creación. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
authConfig Configuración de autenticación de un clúster. AuthConfig de
citusVersion La versión de la extensión Citus en todos los servidores de clúster. cuerda
coordinatorEnablePublicIpAccess Si el acceso público está habilitado en el coordinador. Bool
coordinatorServerEdition Edición de un servidor de coordinación (valor predeterminado: GeneralPurpose). Necesario para la creación. cuerda
coordinatorStorageQuotaInMb Almacenamiento de un servidor en MB. Necesario para la creación. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
coordinadorVCores Recuento de núcleos virtuales de un servidor (máximo: 96). Necesario para la creación. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
nombreDeBaseDeDatos Nombre de la base de datos del clúster. Solo se admite una base de datos por clúster. cuerda
dataEncryption Propiedades de cifrado de datos de un clúster. DataEncryption
enableGeoBackup Si la copia de seguridad del clúster se almacena en otra región de Azure además de la copia de seguridad almacenada en la región del clúster. Habilitado solo en el momento de la creación del clúster. Bool
enableHa Si la alta disponibilidad (HA) está habilitada o no para el clúster. Bool
enableShardsOnCoordinator Si las tablas distribuidas se colocan en el coordinador o no. Debe establecerse en "true" en clústeres de un solo nodo. Requiere reequilibrio de particiones después de cambiar el valor. Bool
maintenanceWindow Ventana de mantenimiento de un clúster. MaintenanceWindow
nodeCount Recuento de nodos de trabajo del clúster. Cuando el número de nodos es 0, representa una configuración de nodo único con la capacidad de crear tablas distribuidas en ese nodo. 2 o más nodos de trabajo representan la configuración de varios nodos. El valor de recuento de nodos no puede ser 1. Necesario para la creación. Int
nodeEnablePublicIpAccess Si el acceso público está habilitado en los nodos de trabajo. Bool
nodeServerEdition Edición de un servidor de nodo (valor predeterminado: MemoryOptimized). cuerda
nodeStorageQuotaInMb Almacenamiento en MB en cada nodo de trabajo. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
nodoVCores Proceso en núcleos virtuales en cada nodo de trabajo (máximo: 104). Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
pointInTimeUTC Fecha y hora en formato UTC (ISO8601) para la restauración del clúster. cuerda
postgresqlVersion La versión principal de PostgreSQL en todos los servidores de clúster. cuerda
preferredPrimaryZone Zona de disponibilidad principal preferida (AZ) para todos los servidores de clúster. cuerda
ubicaciónFuente Región de Azure del clúster de origen para clústeres de réplica de lectura. cuerda
sourceResourceId Identificador de recurso del clúster de origen para clústeres de réplica de lectura. cuerda

Cifrado de datos

Nombre Descripción Valor
primaryKeyUri URI de la clave del almacén de claves para el cifrado de datos del servidor principal. cuerda
primaryUserAssignedIdentityId Identificador de recurso de la identidad asignada por el usuario que se usará para el cifrado de datos del servidor principal. cuerda
tipo "AzureKeyVault"
'SystemAssigned'

IdentityProperties (Propiedades de identidad)

Nombre Descripción Valor
tipo 'SystemAssigned'
'Asignado por el usuario'
identidades asignadas por el usuario Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Nombre Descripción Valor

MaintenanceWindow

Nombre Descripción Valor
customWindow Indica si la ventana de mantenimiento personalizada está habilitada o no. cuerda
dayOfWeek Día preferido de la semana para la ventana de mantenimiento. Int
startHour Hora de inicio dentro del día preferido de la semana para la ventana de mantenimiento. Int
startMinute Minuto de inicio dentro de la hora de inicio de la ventana de mantenimiento. Int

TrackedResourceTags

Nombre Descripción Valor

IdentidadAsignadaPorElUsuario

Nombre Descripción Valor

Ejemplos de uso

Ejemplos de Bicep

Un ejemplo básico de implementación de Azure Cosmos DB para un clúster de 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: administratorLoginPassword
    coordinatorEnablePublicIpAccess: true
    coordinatorServerEdition: 'GeneralPurpose'
    coordinatorStorageQuotaInMb: 131072
    coordinatorVCores: 2
    enableHa: false
    nodeCount: 0
    nodeEnablePublicIpAccess: false
    nodeServerEdition: 'MemoryOptimized'
  }
}

Definición de recursos de plantilla de ARM

El tipo de recurso serverGroupsv2 se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DBforPostgreSQL/serverGroupsv2, agregue el siguiente JSON a la plantilla.

{
  "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 propiedad

Microsoft.DBforPostgreSQL/serverGroupsv2

Nombre Descripción Valor
apiVersion La versión de api '2023-03-02-preestreno'
identidad Describe la identidad del clúster. IdentityProperties
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 40
Patrón = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obligatorio)
Propiedades Propiedades del clúster. clusterProperties de
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso 'Microsoft.DBforPostgreSQL/serverGroupsv2'

AuthConfig

Nombre Descripción Valor
activeDirectoryAuth 'Desactivado'
'habilitado'
passwordAuth 'Desactivado'
'habilitado'

ClusterProperties (Propiedades de clúster)

Nombre Descripción Valor
administratorLoginPassword Contraseña del inicio de sesión del administrador. Necesario para la creación. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
authConfig Configuración de autenticación de un clúster. AuthConfig de
citusVersion La versión de la extensión Citus en todos los servidores de clúster. cuerda
coordinatorEnablePublicIpAccess Si el acceso público está habilitado en el coordinador. Bool
coordinatorServerEdition Edición de un servidor de coordinación (valor predeterminado: GeneralPurpose). Necesario para la creación. cuerda
coordinatorStorageQuotaInMb Almacenamiento de un servidor en MB. Necesario para la creación. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
coordinadorVCores Recuento de núcleos virtuales de un servidor (máximo: 96). Necesario para la creación. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
nombreDeBaseDeDatos Nombre de la base de datos del clúster. Solo se admite una base de datos por clúster. cuerda
dataEncryption Propiedades de cifrado de datos de un clúster. DataEncryption
enableGeoBackup Si la copia de seguridad del clúster se almacena en otra región de Azure además de la copia de seguridad almacenada en la región del clúster. Habilitado solo en el momento de la creación del clúster. Bool
enableHa Si la alta disponibilidad (HA) está habilitada o no para el clúster. Bool
enableShardsOnCoordinator Si las tablas distribuidas se colocan en el coordinador o no. Debe establecerse en "true" en clústeres de un solo nodo. Requiere reequilibrio de particiones después de cambiar el valor. Bool
maintenanceWindow Ventana de mantenimiento de un clúster. MaintenanceWindow
nodeCount Recuento de nodos de trabajo del clúster. Cuando el número de nodos es 0, representa una configuración de nodo único con la capacidad de crear tablas distribuidas en ese nodo. 2 o más nodos de trabajo representan la configuración de varios nodos. El valor de recuento de nodos no puede ser 1. Necesario para la creación. Int
nodeEnablePublicIpAccess Si el acceso público está habilitado en los nodos de trabajo. Bool
nodeServerEdition Edición de un servidor de nodo (valor predeterminado: MemoryOptimized). cuerda
nodeStorageQuotaInMb Almacenamiento en MB en cada nodo de trabajo. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
nodoVCores Proceso en núcleos virtuales en cada nodo de trabajo (máximo: 104). Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
pointInTimeUTC Fecha y hora en formato UTC (ISO8601) para la restauración del clúster. cuerda
postgresqlVersion La versión principal de PostgreSQL en todos los servidores de clúster. cuerda
preferredPrimaryZone Zona de disponibilidad principal preferida (AZ) para todos los servidores de clúster. cuerda
ubicaciónFuente Región de Azure del clúster de origen para clústeres de réplica de lectura. cuerda
sourceResourceId Identificador de recurso del clúster de origen para clústeres de réplica de lectura. cuerda

Cifrado de datos

Nombre Descripción Valor
primaryKeyUri URI de la clave del almacén de claves para el cifrado de datos del servidor principal. cuerda
primaryUserAssignedIdentityId Identificador de recurso de la identidad asignada por el usuario que se usará para el cifrado de datos del servidor principal. cuerda
tipo "AzureKeyVault"
'SystemAssigned'

IdentityProperties (Propiedades de identidad)

Nombre Descripción Valor
tipo 'SystemAssigned'
'Asignado por el usuario'
identidades asignadas por el usuario Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Nombre Descripción Valor

MaintenanceWindow

Nombre Descripción Valor
customWindow Indica si la ventana de mantenimiento personalizada está habilitada o no. cuerda
dayOfWeek Día preferido de la semana para la ventana de mantenimiento. Int
startHour Hora de inicio dentro del día preferido de la semana para la ventana de mantenimiento. Int
startMinute Minuto de inicio dentro de la hora de inicio de la ventana de mantenimiento. Int

TrackedResourceTags

Nombre Descripción Valor

IdentidadAsignadaPorElUsuario

Nombre Descripción Valor

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso serverGroupsv2 se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DBforPostgreSQL/serverGroupsv2, agregue el siguiente terraform a la plantilla.

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 propiedad

Microsoft.DBforPostgreSQL/serverGroupsv2

Nombre Descripción Valor
identidad Describe la identidad del clúster. IdentityProperties
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 40
Patrón = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obligatorio)
Propiedades Propiedades del clúster. clusterProperties de
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"

AuthConfig

Nombre Descripción Valor
activeDirectoryAuth 'Desactivado'
'habilitado'
passwordAuth 'Desactivado'
'habilitado'

ClusterProperties (Propiedades de clúster)

Nombre Descripción Valor
administratorLoginPassword Contraseña del inicio de sesión del administrador. Necesario para la creación. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
authConfig Configuración de autenticación de un clúster. AuthConfig de
citusVersion La versión de la extensión Citus en todos los servidores de clúster. cuerda
coordinatorEnablePublicIpAccess Si el acceso público está habilitado en el coordinador. Bool
coordinatorServerEdition Edición de un servidor de coordinación (valor predeterminado: GeneralPurpose). Necesario para la creación. cuerda
coordinatorStorageQuotaInMb Almacenamiento de un servidor en MB. Necesario para la creación. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
coordinadorVCores Recuento de núcleos virtuales de un servidor (máximo: 96). Necesario para la creación. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
nombreDeBaseDeDatos Nombre de la base de datos del clúster. Solo se admite una base de datos por clúster. cuerda
dataEncryption Propiedades de cifrado de datos de un clúster. DataEncryption
enableGeoBackup Si la copia de seguridad del clúster se almacena en otra región de Azure además de la copia de seguridad almacenada en la región del clúster. Habilitado solo en el momento de la creación del clúster. Bool
enableHa Si la alta disponibilidad (HA) está habilitada o no para el clúster. Bool
enableShardsOnCoordinator Si las tablas distribuidas se colocan en el coordinador o no. Debe establecerse en "true" en clústeres de un solo nodo. Requiere reequilibrio de particiones después de cambiar el valor. Bool
maintenanceWindow Ventana de mantenimiento de un clúster. MaintenanceWindow
nodeCount Recuento de nodos de trabajo del clúster. Cuando el número de nodos es 0, representa una configuración de nodo único con la capacidad de crear tablas distribuidas en ese nodo. 2 o más nodos de trabajo representan la configuración de varios nodos. El valor de recuento de nodos no puede ser 1. Necesario para la creación. Int
nodeEnablePublicIpAccess Si el acceso público está habilitado en los nodos de trabajo. Bool
nodeServerEdition Edición de un servidor de nodo (valor predeterminado: MemoryOptimized). cuerda
nodeStorageQuotaInMb Almacenamiento en MB en cada nodo de trabajo. Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
nodoVCores Proceso en núcleos virtuales en cada nodo de trabajo (máximo: 104). Consulte /azure/cosmos-db/postgresql/resources-compute para obtener más información. Int
pointInTimeUTC Fecha y hora en formato UTC (ISO8601) para la restauración del clúster. cuerda
postgresqlVersion La versión principal de PostgreSQL en todos los servidores de clúster. cuerda
preferredPrimaryZone Zona de disponibilidad principal preferida (AZ) para todos los servidores de clúster. cuerda
ubicaciónFuente Región de Azure del clúster de origen para clústeres de réplica de lectura. cuerda
sourceResourceId Identificador de recurso del clúster de origen para clústeres de réplica de lectura. cuerda

Cifrado de datos

Nombre Descripción Valor
primaryKeyUri URI de la clave del almacén de claves para el cifrado de datos del servidor principal. cuerda
primaryUserAssignedIdentityId Identificador de recurso de la identidad asignada por el usuario que se usará para el cifrado de datos del servidor principal. cuerda
tipo "AzureKeyVault"
'SystemAssigned'

IdentityProperties (Propiedades de identidad)

Nombre Descripción Valor
tipo 'SystemAssigned'
'Asignado por el usuario'
identidades asignadas por el usuario Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Nombre Descripción Valor

MaintenanceWindow

Nombre Descripción Valor
customWindow Indica si la ventana de mantenimiento personalizada está habilitada o no. cuerda
dayOfWeek Día preferido de la semana para la ventana de mantenimiento. Int
startHour Hora de inicio dentro del día preferido de la semana para la ventana de mantenimiento. Int
startMinute Minuto de inicio dentro de la hora de inicio de la ventana de mantenimiento. Int

TrackedResourceTags

Nombre Descripción Valor

IdentidadAsignadaPorElUsuario

Nombre Descripción Valor

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación de Azure Cosmos DB para un clúster de 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    = ["*"]
}