Partager via

Microsoft.DocumentDB mongoClusters 2023-09-15-preview

  • Article

Définition de ressource Bicep

Le type de ressource mongoClusters 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 des ressources

Pour créer une ressource Microsoft.DocumentDB/mongoClusters, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'Shard'
        nodeCount: int
        sku: 'string'
      }
    ]
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
}

Valeurs de propriétés

mongoClusters

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)
location Emplacement géographique où réside la ressource chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du cluster mongo. MongoClusterProperties

MongoClusterProperties

Nom Description Valeur
administratorLogin Connexion de l’administrateur pour le cluster mongo. string
administratorLoginPassword Mot de passe de la connexion administrateur. string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
createMode Mode permettant de créer un cluster mongo. 'Par défaut'
'PointInTimeRestore'
'Restaurer'
nodeGroupSpecs Liste des spécifications de groupe de nœuds dans le cluster. NodeGroupSpec[]

Contraintes :
Longueur minimale = 1
restoreParameters Paramètres utilisés pour les opérations de restauration MongoClusterRestoreParameters
serverVersion Version du serveur Mongo DB. Par défaut, la dernière version disponible n’est pas spécifiée. string

NodeGroupSpec

Nom Description Valeur
diskSizeGB Taille de stockage sur disque pour le groupe de nœuds en Go. Exemples de valeurs : 128, 256, 512, 1024. int
enableHa Indique si la haute disponibilité est activée sur le groupe de nœuds. bool
kind Type de nœud déployé dans le groupe de nœuds. 'Shard'
nodeCount Nombre de nœuds dans le groupe de nœuds. int
sku Référence de ressource pour le groupe de nœuds. Cela définit la taille de l’UC et de la mémoire provisionnée pour chaque nœud. Exemples de valeurs : « M30 », « M40 ». string

MongoClusterRestoreParameters

Nom Description Valeur
pointInTimeUTC Point UTC dans le temps pour restaurer un cluster mongo string
sourceResourceId ID de ressource pour localiser le cluster source à restaurer string

Définition de ressources de modèle ARM

Le type de ressource mongoClusters 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 des ressources

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

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "Shard",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  }
}

Valeurs de propriétés

mongoClusters

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/mongoClusters »
apiVersion Version de l’API de ressource « 2023-09-15-preview »
name Nom de la ressource chaîne (obligatoire)
location Emplacement géographique où réside la ressource chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du cluster mongo. MongoClusterProperties

MongoClusterProperties

Nom Description Valeur
administratorLogin Connexion de l’administrateur pour le cluster mongo. string
administratorLoginPassword Mot de passe de la connexion administrateur. string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
createMode Mode permettant de créer un cluster mongo. 'Par défaut'
'PointInTimeRestore'
'Restaurer'
nodeGroupSpecs Liste des spécifications de groupe de nœuds dans le cluster. NodeGroupSpec[]

Contraintes :
Longueur minimale = 1
restoreParameters Paramètres utilisés pour les opérations de restauration MongoClusterRestoreParameters
serverVersion Version du serveur Mongo DB. Par défaut, la dernière version disponible n’est pas spécifiée. string

NodeGroupSpec

Nom Description Valeur
diskSizeGB Taille de stockage sur disque pour le groupe de nœuds en Go. Exemples de valeurs : 128, 256, 512, 1024. int
enableHa Indique si la haute disponibilité est activée sur le groupe de nœuds. bool
kind Type de nœud déployé dans le groupe de nœuds. 'Shard'
nodeCount Nombre de nœuds dans le groupe de nœuds. int
sku Référence de ressource pour le groupe de nœuds. Cela définit la taille de l’UC et de la mémoire provisionnée pour chaque nœud. Exemples de valeurs : « M30 », « M40 ». string

MongoClusterRestoreParameters

Nom Description Valeur
pointInTimeUTC Point UTC dans le temps pour restaurer un cluster mongo string
sourceResourceId ID de ressource pour localiser le cluster source à restaurer string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource mongoClusters 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 des ressources

Pour créer une ressource Microsoft.DocumentDB/mongoClusters, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "Shard"
          nodeCount = int
          sku = "string"
        }
      ]
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Valeurs de propriétés

mongoClusters

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/mongoClusters@2023-09-15-preview »
name Nom de la ressource string (obligatoire)
location Emplacement géographique où réside la ressource string (obligatoire)
parent_id Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. string (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés du cluster mongo. MongoClusterProperties

MongoClusterProperties

Nom Description Valeur
administratorLogin Connexion de l’administrateur pour le cluster Mongo. string
administratorLoginPassword Mot de passe de la connexion administrateur. string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
createMode Mode pour créer un cluster Mongo. « Par défaut »
« PointInTimeRestore »
« Restaurer »
nodeGroupSpecs Liste des spécifications de groupe de nœuds dans le cluster. NodeGroupSpec[]

Contraintes :
Longueur minimale = 1
restoreParameters Paramètres utilisés pour les opérations de restauration MongoClusterRestoreParameters
serverVersion Version du serveur Mongo DB. La valeur par défaut est la dernière version disponible si elle n’est pas spécifiée. string

NodeGroupSpec

Nom Description Valeur
diskSizeGB Taille de stockage sur disque pour le groupe de nœuds en Go. Exemples de valeurs : 128, 256, 512, 1024. int
enableHa Indique si la haute disponibilité est activée sur le groupe de nœuds. bool
kind Type de nœud déployé dans le groupe de nœuds. « Shard »
nodeCount Nombre de nœuds dans le groupe de nœuds. int
sku Référence SKU de ressource pour le groupe de nœuds. Cela définit la taille du processeur et de la mémoire provisionnés pour chaque nœud. Exemples de valeurs : « M30 », « M40 ». string

MongoClusterRestoreParameters

Nom Description Valeur
pointInTimeUTC Point UTC dans le temps pour restaurer un cluster Mongo string
sourceResourceId ID de ressource pour localiser le cluster source à restaurer string