Base de données Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2023-04-15

• La plus récente
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• Préversion du 01/03/2023
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 15-06-2021
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 15-01-2021
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Définition de ressource Bicep

Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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-04-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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 propriétés

databaseAccounts/mongodbDatabases/collections

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	string (obligatoire)
location	Emplacement du groupe de ressources auquel appartient la ressource.	string
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour 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 : mongodbDatabases
properties	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatoire)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nom	Description	Valeur
options	Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	Format JSON standard d’une collection MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obligatoire)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique.	AutoscaleSettings
throughput	Unités de requête par seconde. Par exemple, « débit » : 10000.	int

AutoscaleSettings

Nom	Description	Valeur
maxThroughput	Représente le débit maximal jusqu’à lequel la ressource peut effectuer un scale-up.	int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nom	Description	Valeur
analyticalStorageTtl	Durée de vie analytique.	int
id	Nom de la collection Cosmos DB MongoDB	string (obligatoire)
index	Liste des clés d’index	MongoIndex[]
shardKey	Paire clé-valeur de clés de partition à appliquer à la demande.	ShardKeys

MongoIndex

Nom	Description	Valeur
key	Clés d’index de collection Cosmos DB MongoDB	MongoIndexKeys
options	Options de clé 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 quelques secondes	int
unique	Est unique ou non	bool

ShardKeys

Nom	Description	Valeur
{propriété personnalisée}		string

Modèles de démarrage rapide

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

Modèle	Description
Créer un compte Azure Cosmos pour 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 ressources de modèle ARM

Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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-04-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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 propriétés

databaseAccounts/mongodbDatabases/collections

Nom	Description	Valeur
type	Type de ressource	'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'
apiVersion	Version de l’API de ressource	'2023-04-15'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	string (obligatoire)
location	Emplacement du groupe de ressources auquel appartient la ressource.	string
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatoire)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nom	Description	Valeur
options	Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	Format JSON standard d’une collection MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obligatoire)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique.	AutoscaleSettings
throughput	Unités de requête par seconde. Par exemple, « débit » : 10000.	int

AutoscaleSettings

Nom	Description	Valeur
maxThroughput	Représente le débit maximal jusqu’à lequel la ressource peut effectuer un scale-up.	int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nom	Description	Valeur
analyticalStorageTtl	Durée de vie analytique.	int
id	Nom de la collection Cosmos DB MongoDB	string (obligatoire)
index	Liste des clés d’index	MongoIndex[]
shardKey	Paire clé-valeur de clés de partition à appliquer à la demande.	ShardKeys

MongoIndex

Nom	Description	Valeur
key	Clés d’index de collection Cosmos DB MongoDB	MongoIndexKeys
options	Options de clé 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 quelques secondes	int
unique	Est unique ou non	bool

ShardKeys

Nom	Description	Valeur
{propriété personnalisée}		string

Modèles de démarrage rapide

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

Modèle	Description
Créer un compte Azure Cosmos pour 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 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 d’API, consultez journal des modifications.

Format des ressources

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-04-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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 propriétés

databaseAccounts/mongodbDatabases/collections

Nom	Description	Valeur
type	Type de ressource	« Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-04-15 »
name	Nom de la ressource	chaîne (obligatoire)
location	Emplacement du groupe de ressources auquel appartient la ressource.	string
parent_id	ID de la ressource qui est le parent de cette ressource.	ID pour la ressource de type : mongodbDatabases
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».	Dictionnaire de noms et de valeurs d’étiquettes.
properties	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatoire)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nom	Description	Valeur
options	Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	Format JSON standard d’une collection MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obligatoire)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique.	AutoscaleSettings
throughput	Unités de requête par seconde. Par exemple, « débit » : 10000.	int

Paramètres de mise à l’échelle automatique

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

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 demande.	ShardKeys

MongoIndex

Nom	Description	Valeur
key	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
options	Options de clé d’index de collection MongoDB Cosmos DB	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 quelques secondes	int
unique	Est unique ou non	bool

ShardKeys

Nom	Description	Valeur
{propriété personnalisée}		string