Partager via

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-09-15

  • Article

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-09-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de la propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nom Description Valeur
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts/mongodbDatabases
Propriétés Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
ressource Format JSON standard d’une collection MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatoire)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. Int
id Nom de la collection MongoDB Cosmos DB chaîne (obligatoire)
Index Liste des clés d’index MongoIndex[]
shardKey Paire clé-valeur de clés de partition à appliquer pour la requête. ShardKeys

MongoIndex

Nom Description Valeur
clé Clés d’index de collection MongoDB Cosmos DB MongoIndexKeys
Options Options de clé d’index d’index de collection Cosmos DB MongoDB MongoIndexOptions

MongoIndexKeys

Nom Description Valeur
Clés Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB string[]

MongoIndexOptions

Nom Description Valeur
expireAfterSeconds Expirer après secondes Int
unique Est unique ou non Bool

ShardKeys

Nom Description Valeur

Étiquettes

Nom Description Valeur

Exemples d’utilisation

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Description
Créer un compte Azure Cosmos pour l' de l’API MongoDB Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide d’un débit partagé et dédié avec deux collections.
Créer un compte Azure Cosmos pour la mise à l’échelle automatique de l’API MongoDB Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide du débit de mise à l’échelle automatique partagé et dédié.

Définition de ressource de modèle ARM

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2023-09-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de la propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nom Description Valeur
apiVersion Version de l’API '2023-09-15'
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatoire)
é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/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
ressource Format JSON standard d’une collection MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatoire)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. Int
id Nom de la collection MongoDB Cosmos DB chaîne (obligatoire)
Index Liste des clés d’index MongoIndex[]
shardKey Paire clé-valeur de clés de partition à appliquer pour la requête. ShardKeys

MongoIndex

Nom Description Valeur
clé Clés d’index de collection MongoDB Cosmos DB MongoIndexKeys
Options Options de clé d’index d’index de collection Cosmos DB MongoDB MongoIndexOptions

MongoIndexKeys

Nom Description Valeur
Clés Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB string[]

MongoIndexOptions

Nom Description Valeur
expireAfterSeconds Expirer après secondes Int
unique Est unique ou non Bool

ShardKeys

Nom Description Valeur

Étiquettes

Nom Description Valeur

Exemples d’utilisation

Modèles de démarrage rapide Microsoft Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Description
Créer un compte Azure Cosmos pour l' de l’API MongoDB

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide d’un débit partagé et dédié avec deux collections.
Créer un compte Azure Cosmos pour la mise à l’échelle automatique de l’API MongoDB

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide du débit de mise à l’échelle automatique partagé et dédié.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/mongodbDatabases/collections 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/databaseAccounts/mongodbDatabases/collections, ajoutez terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-09-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  }
}

Valeurs de la propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nom Description Valeur
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts/mongodbDatabases
Propriétés Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-09-15 »

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
ressource Format JSON standard d’une collection MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatoire)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. Int
id Nom de la collection MongoDB Cosmos DB chaîne (obligatoire)
Index Liste des clés d’index MongoIndex[]
shardKey Paire clé-valeur de clés de partition à appliquer pour la requête. ShardKeys

MongoIndex

Nom Description Valeur
clé Clés d’index de collection MongoDB Cosmos DB MongoIndexKeys
Options Options de clé d’index d’index de collection Cosmos DB MongoDB MongoIndexOptions

MongoIndexKeys

Nom Description Valeur
Clés Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB string[]

MongoIndexOptions

Nom Description Valeur
expireAfterSeconds Expirer après secondes Int
unique Est unique ou non Bool

ShardKeys

Nom Description Valeur

Étiquettes

Nom Description Valeur