Partager via


Microsoft.DBforPostgreSQL serverGroupsv2 2022-11-08

Définition de ressource Bicep

Le type de ressource serverGroupsv2 peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DBforPostgreSQL/serverGroupsv2, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08' = {
  location: 'string'
  name: 'string'
  properties: {
    administratorLoginPassword: 'string'
    citusVersion: 'string'
    coordinatorEnablePublicIpAccess: bool
    coordinatorServerEdition: 'string'
    coordinatorStorageQuotaInMb: int
    coordinatorVCores: int
    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'
  }
}

Valeurs de propriété

ClusterProperties

Nom Description Valeur
administratorLoginPassword Mot de passe de la connexion administrateur. Obligatoire pour la création. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
citusVersion Version de l’extension Citus sur tous les serveurs de cluster. corde
coordinatorEnablePublicIpAccess Si l’accès public est activé sur le coordinateur. Bool
coordinatorServerEdition Édition d’un serveur coordinateur (par défaut : GeneralPurpose). Obligatoire pour la création. corde
coordinatorStorageQuotaInMb Stockage d’un serveur en Mo. Obligatoire pour la création. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
coordinatorVCores Nombre de vCores d’un serveur (max : 96). Obligatoire pour la création. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
enableHa Si la haute disponibilité est activée ou non pour le cluster. Bool
enableShardsOnCoordinator Si les tables distribuées sont placées sur coordinateur ou non. Doit être défini sur « true » sur les clusters à nœud unique. Nécessite un rééquilibrage de partition après la modification de la valeur. Bool
maintenanceWindow Fenêtre de maintenance d’un cluster. MaintenanceWindow
nodeCount Nombre de nœuds Worker du cluster. Lorsque le nombre de nœuds est égal à 0, il représente une configuration de nœud unique avec la possibilité de créer des tables distribuées sur ce nœud. 2 nœuds Worker ou plus représentent la configuration à plusieurs nœuds. La valeur du nombre de nœuds ne peut pas être 1. Obligatoire pour la création. Int
nodeEnablePublicIpAccess Si l’accès public est activé sur les nœuds Worker. Bool
nodeServerEdition Édition d’un serveur de nœuds (par défaut : MemoryOptimized). corde
nodeStorageQuotaInMb Stockage en Mo sur chaque nœud Worker. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
nodeVCores Calcul dans vCores sur chaque nœud Worker (max : 104). Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Date et heure au format UTC (format ISO8601) pour la restauration du cluster. corde
postgresqlVersion Version principale de PostgreSQL sur tous les serveurs de cluster. corde
preferredPrimaryZone Zone de disponibilité principale préférée (AZ) pour tous les serveurs de cluster. corde
sourceLocation Région Azure du cluster source pour les clusters réplicas en lecture. corde
sourceResourceId ID de ressource du cluster source pour les clusters réplicas en lecture. corde

MaintenanceWindow

Nom Description Valeur
customWindow Indique si la fenêtre de maintenance personnalisée est activée ou non. corde
dayOfWeek Jour préféré de la semaine pour la fenêtre de maintenance. Int
startHour Heure de début dans le jour préféré de la semaine pour la fenêtre de maintenance. Int
startMinute Minute de début dans l’heure de début de la fenêtre de maintenance. Int

Microsoft.DBforPostgreSQL/serverGroupsv2

Nom Description Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 40
Modèle = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obligatoire)
Propriétés Propriétés du cluster. clusterProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

TrackedResourceTags

Nom Description Valeur

Définition de ressource de modèle ARM

Le type de ressource serverGroupsv2 peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DBforPostgreSQL/serverGroupsv2, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "apiVersion": "2022-11-08",
  "name": "string",
  "location": "string",
  "properties": {
    "administratorLoginPassword": "string",
    "citusVersion": "string",
    "coordinatorEnablePublicIpAccess": "bool",
    "coordinatorServerEdition": "string",
    "coordinatorStorageQuotaInMb": "int",
    "coordinatorVCores": "int",
    "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"
  }
}

Valeurs de propriété

ClusterProperties

Nom Description Valeur
administratorLoginPassword Mot de passe de la connexion administrateur. Obligatoire pour la création. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
citusVersion Version de l’extension Citus sur tous les serveurs de cluster. corde
coordinatorEnablePublicIpAccess Si l’accès public est activé sur le coordinateur. Bool
coordinatorServerEdition Édition d’un serveur coordinateur (par défaut : GeneralPurpose). Obligatoire pour la création. corde
coordinatorStorageQuotaInMb Stockage d’un serveur en Mo. Obligatoire pour la création. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
coordinatorVCores Nombre de vCores d’un serveur (max : 96). Obligatoire pour la création. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
enableHa Si la haute disponibilité est activée ou non pour le cluster. Bool
enableShardsOnCoordinator Si les tables distribuées sont placées sur coordinateur ou non. Doit être défini sur « true » sur les clusters à nœud unique. Nécessite un rééquilibrage de partition après la modification de la valeur. Bool
maintenanceWindow Fenêtre de maintenance d’un cluster. MaintenanceWindow
nodeCount Nombre de nœuds Worker du cluster. Lorsque le nombre de nœuds est égal à 0, il représente une configuration de nœud unique avec la possibilité de créer des tables distribuées sur ce nœud. 2 nœuds Worker ou plus représentent la configuration à plusieurs nœuds. La valeur du nombre de nœuds ne peut pas être 1. Obligatoire pour la création. Int
nodeEnablePublicIpAccess Si l’accès public est activé sur les nœuds Worker. Bool
nodeServerEdition Édition d’un serveur de nœuds (par défaut : MemoryOptimized). corde
nodeStorageQuotaInMb Stockage en Mo sur chaque nœud Worker. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
nodeVCores Calcul dans vCores sur chaque nœud Worker (max : 104). Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Date et heure au format UTC (format ISO8601) pour la restauration du cluster. corde
postgresqlVersion Version principale de PostgreSQL sur tous les serveurs de cluster. corde
preferredPrimaryZone Zone de disponibilité principale préférée (AZ) pour tous les serveurs de cluster. corde
sourceLocation Région Azure du cluster source pour les clusters réplicas en lecture. corde
sourceResourceId ID de ressource du cluster source pour les clusters réplicas en lecture. corde

MaintenanceWindow

Nom Description Valeur
customWindow Indique si la fenêtre de maintenance personnalisée est activée ou non. corde
dayOfWeek Jour préféré de la semaine pour la fenêtre de maintenance. Int
startHour Heure de début dans le jour préféré de la semaine pour la fenêtre de maintenance. Int
startMinute Minute de début dans l’heure de début de la fenêtre de maintenance. Int

Microsoft.DBforPostgreSQL/serverGroupsv2

Nom Description Valeur
apiVersion Version de l’API '2022-11-08'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 40
Modèle = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obligatoire)
Propriétés Propriétés du cluster. clusterProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DBforPostgreSQL/serverGroupsv2'

TrackedResourceTags

Nom Description Valeur

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource serverGroupsv2 peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DBforPostgreSQL/serverGroupsv2, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLoginPassword = "string"
      citusVersion = "string"
      coordinatorEnablePublicIpAccess = bool
      coordinatorServerEdition = "string"
      coordinatorStorageQuotaInMb = int
      coordinatorVCores = int
      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"
    }
  })
}

Valeurs de propriété

ClusterProperties

Nom Description Valeur
administratorLoginPassword Mot de passe de la connexion administrateur. Obligatoire pour la création. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
citusVersion Version de l’extension Citus sur tous les serveurs de cluster. corde
coordinatorEnablePublicIpAccess Si l’accès public est activé sur le coordinateur. Bool
coordinatorServerEdition Édition d’un serveur coordinateur (par défaut : GeneralPurpose). Obligatoire pour la création. corde
coordinatorStorageQuotaInMb Stockage d’un serveur en Mo. Obligatoire pour la création. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
coordinatorVCores Nombre de vCores d’un serveur (max : 96). Obligatoire pour la création. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
enableHa Si la haute disponibilité est activée ou non pour le cluster. Bool
enableShardsOnCoordinator Si les tables distribuées sont placées sur coordinateur ou non. Doit être défini sur « true » sur les clusters à nœud unique. Nécessite un rééquilibrage de partition après la modification de la valeur. Bool
maintenanceWindow Fenêtre de maintenance d’un cluster. MaintenanceWindow
nodeCount Nombre de nœuds Worker du cluster. Lorsque le nombre de nœuds est égal à 0, il représente une configuration de nœud unique avec la possibilité de créer des tables distribuées sur ce nœud. 2 nœuds Worker ou plus représentent la configuration à plusieurs nœuds. La valeur du nombre de nœuds ne peut pas être 1. Obligatoire pour la création. Int
nodeEnablePublicIpAccess Si l’accès public est activé sur les nœuds Worker. Bool
nodeServerEdition Édition d’un serveur de nœuds (par défaut : MemoryOptimized). corde
nodeStorageQuotaInMb Stockage en Mo sur chaque nœud Worker. Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
nodeVCores Calcul dans vCores sur chaque nœud Worker (max : 104). Pour plus d’informations, consultez /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Date et heure au format UTC (format ISO8601) pour la restauration du cluster. corde
postgresqlVersion Version principale de PostgreSQL sur tous les serveurs de cluster. corde
preferredPrimaryZone Zone de disponibilité principale préférée (AZ) pour tous les serveurs de cluster. corde
sourceLocation Région Azure du cluster source pour les clusters réplicas en lecture. corde
sourceResourceId ID de ressource du cluster source pour les clusters réplicas en lecture. corde

MaintenanceWindow

Nom Description Valeur
customWindow Indique si la fenêtre de maintenance personnalisée est activée ou non. corde
dayOfWeek Jour préféré de la semaine pour la fenêtre de maintenance. Int
startHour Heure de début dans le jour préféré de la semaine pour la fenêtre de maintenance. Int
startMinute Minute de début dans l’heure de début de la fenêtre de maintenance. Int

Microsoft.DBforPostgreSQL/serverGroupsv2

Nom Description Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 40
Modèle = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (obligatoire)
Propriétés Propriétés du cluster. clusterProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08 »

TrackedResourceTags

Nom Description Valeur