Microsoft.DBforPostgreSQL serverGroupsv2

Article
12/09/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez commandes de déploiement de 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 bicep suivant à votre modèle.

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'
  }
}

Valeurs de propriété

AuthConfig

Nom	Description	Valeur
activeDirectoryAuth		'disabled' 'enabled'
passwordAuth		'disabled' 'enabled'

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é.
authConfig	Configuration de l’authentification d’un cluster.	AuthConfig
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
databaseName	Nom de la base de données du cluster. Une seule base de données par cluster est prise en charge.	corde
dataEncryption	Propriétés de chiffrement des données d’un cluster.	dataEncryption
enableGeoBackup	Si la sauvegarde de cluster est stockée dans une autre région Azure en plus de la copie de la sauvegarde stockée dans la région du cluster. Activé uniquement au moment de la création du cluster.	Bool
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

DataEncryption

Nom	Description	Valeur
primaryKeyUri	URI de la clé dans keyvault pour le chiffrement des données du serveur principal.	corde
primaryUserAssignedIdentityId	ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données du serveur principal.	corde
type		'AzureKeyVault' 'SystemAssigned'

IdentityProperties

Nom	Description	Valeur
type		'SystemAssigned' 'UserAssigned'
userAssignedIdentities	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

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
identité	Décrit l’identité du cluster.	IdentityProperties
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 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

UserAssignedIdentities

Nom	Description	Valeur

UserAssignedIdentity

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 :

groupes de ressources - Consultez commandes de déploiement de 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 code JSON suivant à votre modèle.

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

Valeurs de propriété

AuthConfig

Nom	Description	Valeur
activeDirectoryAuth		'disabled' 'enabled'
passwordAuth		'disabled' 'enabled'

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é.
authConfig	Configuration de l’authentification d’un cluster.	AuthConfig
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
databaseName	Nom de la base de données du cluster. Une seule base de données par cluster est prise en charge.	corde
dataEncryption	Propriétés de chiffrement des données d’un cluster.	dataEncryption
enableGeoBackup	Si la sauvegarde de cluster est stockée dans une autre région Azure en plus de la copie de la sauvegarde stockée dans la région du cluster. Activé uniquement au moment de la création du cluster.	Bool
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

DataEncryption

Nom	Description	Valeur
primaryKeyUri	URI de la clé dans keyvault pour le chiffrement des données du serveur principal.	corde
primaryUserAssignedIdentityId	ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données du serveur principal.	corde
type		'AzureKeyVault' 'SystemAssigned'

IdentityProperties

Nom	Description	Valeur
type		'SystemAssigned' 'UserAssigned'
userAssignedIdentities	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

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	'2023-03-02-preview'
identité	Décrit l’identité du cluster.	IdentityProperties
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 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

UserAssignedIdentities

Nom	Description	Valeur

UserAssignedIdentity

Nom	Description	Valeur

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@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"
    }
  })
}

Valeurs de propriété

AuthConfig

Nom	Description	Valeur
activeDirectoryAuth		'disabled' 'enabled'
passwordAuth		'disabled' 'enabled'

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é.
authConfig	Configuration de l’authentification d’un cluster.	AuthConfig
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
databaseName	Nom de la base de données du cluster. Une seule base de données par cluster est prise en charge.	corde
dataEncryption	Propriétés de chiffrement des données d’un cluster.	dataEncryption
enableGeoBackup	Si la sauvegarde de cluster est stockée dans une autre région Azure en plus de la copie de la sauvegarde stockée dans la région du cluster. Activé uniquement au moment de la création du cluster.	Bool
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

DataEncryption

Nom	Description	Valeur
primaryKeyUri	URI de la clé dans keyvault pour le chiffrement des données du serveur principal.	corde
primaryUserAssignedIdentityId	ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données du serveur principal.	corde
type		'AzureKeyVault' 'SystemAssigned'

IdentityProperties

Nom	Description	Valeur
type		'SystemAssigned' 'UserAssigned'
userAssignedIdentities	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

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
identité	Décrit l’identité du cluster.	IdentityProperties
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 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@2023-03-02-preview »

TrackedResourceTags

Nom	Description	Valeur

UserAssignedIdentities

Nom	Description	Valeur

UserAssignedIdentity

Nom	Description	Valeur

Partager via

Microsoft.DBforPostgreSQL serverGroupsv2

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Commentaires

Ressources supplémentaires