Microsoft.DocumentDB mongoClusters 2023-11-15-preview

Article
12/19/2024

Définition de ressource Bicep

Le type de ressource mongoClusters 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.DocumentDB/mongoClusters, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

Microsoft.DocumentDB/mongoClusters

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 = 3 Modèle = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatoire)
Propriétés	Propriétés du cluster mongo.	MongoClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

MongoClusterProperties

Nom	Description	Valeur
administratorLogin	Connexion de l’administrateur pour le cluster mongo.	corde
administratorLoginPassword	Mot de passe de la connexion administrateur.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
createMode	Mode de création d’un cluster mongo.	'Default' 'PointInTimeRestore' 'Restore'
nodeGroupSpecs	Liste des spécifications de groupe de nœuds dans le cluster.	NodeGroupSpec[]
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.	corde

MongoClusterRestoreParameters

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

NodeGroupSpec

Nom	Description	Valeur
diskSizeGB	Taille de stockage du 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
gentil	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ée pour chaque nœud. Exemples de valeurs : « M30 », « M40 ».	corde

TrackedResourceTags

Nom	Description	Valeur

Définition de ressource de modèle ARM

Le type de ressource mongoClusters 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.DocumentDB/mongoClusters, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

Microsoft.DocumentDB/mongoClusters

Nom	Description	Valeur
apiVersion	Version de l’API	'2023-11-15-preview'
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 = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatoire)
Propriétés	Propriétés du cluster mongo.	MongoClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

Nom	Description	Valeur
administratorLogin	Connexion de l’administrateur pour le cluster mongo.	corde
administratorLoginPassword	Mot de passe de la connexion administrateur.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
createMode	Mode de création d’un cluster mongo.	'Default' 'PointInTimeRestore' 'Restore'
nodeGroupSpecs	Liste des spécifications de groupe de nœuds dans le cluster.	NodeGroupSpec[]
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.	corde

MongoClusterRestoreParameters

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

NodeGroupSpec

Nom	Description	Valeur
diskSizeGB	Taille de stockage du 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
gentil	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ée pour chaque nœud. Exemples de valeurs : « M30 », « M40 ».	corde

TrackedResourceTags

Nom	Description	Valeur

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 de ressource

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

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

Valeurs de propriété

Microsoft.DocumentDB/mongoClusters

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 = 3 Modèle = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatoire)
Propriétés	Propriétés du cluster mongo.	MongoClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.DocumentDB/mongoClusters@2023-11-15-preview »

MongoClusterProperties

Nom	Description	Valeur
administratorLogin	Connexion de l’administrateur pour le cluster mongo.	corde
administratorLoginPassword	Mot de passe de la connexion administrateur.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
createMode	Mode de création d’un cluster mongo.	'Default' 'PointInTimeRestore' 'Restore'
nodeGroupSpecs	Liste des spécifications de groupe de nœuds dans le cluster.	NodeGroupSpec[]
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.	corde

MongoClusterRestoreParameters

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

NodeGroupSpec

Nom	Description	Valeur
diskSizeGB	Taille de stockage du 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
gentil	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ée pour chaque nœud. Exemples de valeurs : « M30 », « M40 ».	corde

TrackedResourceTags

Nom	Description	Valeur

Partager via

Microsoft.DocumentDB mongoClusters 2023-11-15-preview

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterRestoreParameters

NodeGroupSpec

TrackedResourceTags

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterRestoreParameters

NodeGroupSpec

TrackedResourceTags

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterRestoreParameters

NodeGroupSpec

TrackedResourceTags

Commentaires

Ressources supplémentaires