az cosmosdb mongodb collection
Note
Ce groupe de commandes a des commandes définies dans Azure CLI et au moins une extension. Installez chaque extension pour bénéficier de ses fonctionnalités étendues. Apprenez-en davantage sur les extensions.
Gérer les collections MongoDB Azure Cosmos DB.
Commandes
| Nom | Description | Type | État |
|---|---|---|---|
| az cosmosdb mongodb collection create |
Créez une collection MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection delete |
Supprimez la collection MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection exists |
Vérifie si une collection MongoDB Azure Cosmos DB existe. |
Core | GA |
| az cosmosdb mongodb collection list |
Répertoriez les collections MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection merge |
Fusionne les partitions d’une collection mongodb. |
Extension | Preview |
| az cosmosdb mongodb collection redistribute-partition-throughput |
Redistribue le débit de partition d’une collection mongodb. |
Extension | Preview |
| az cosmosdb mongodb collection restore |
Restaurez une collection mongodb supprimée dans le même compte. |
Core | GA |
| az cosmosdb mongodb collection restore (cosmosdb-preview extension) |
Restaurez une collection mongodb supprimée dans le même compte. |
Extension | Preview |
| az cosmosdb mongodb collection retrieve-partition-throughput |
Récupérez le débit de partition d’une collection mongodb. |
Extension | Preview |
| az cosmosdb mongodb collection show |
Affichez les détails d’une collection MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection throughput |
Gérer le débit de la collection MongoDB sous un compte Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection throughput migrate |
Migrez le débit de la collection MongoDB entre la mise à l’échelle automatique et l’approvisionnement manuel. |
Core | GA |
| az cosmosdb mongodb collection throughput show |
Obtenez le débit de la collection MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection throughput update |
Mettez à jour le débit de la collection MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
| az cosmosdb mongodb collection update |
Mettez à jour une collection MongoDB sous une base de données MongoDB Azure Cosmos DB. |
Core | GA |
az cosmosdb mongodb collection create
Créez une collection MongoDB sous une base de données MongoDB Azure Cosmos DB.
az cosmosdb mongodb collection create --account-name
--database-name
--name
--resource-group
[--analytical-storage-ttl]
[--idx]
[--max-throughput]
[--shard]
[--throughput]
Exemples
Créez une collection MongoDB Azure Cosmos DB.
az cosmosdb mongodb collection create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyCollection --shard "ShardingKey" --idx @indexes-file.json --throughput "500"
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
Durée de vie analytique, lorsque le stockage analytique est activé.
Index, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, Par exemple, --idx @indexes-file.json ou --idx « [{"key » : {"keys » : ["_ts"]},"options » : {"expireAfterSeconds » : 1000}}, {"key » : {"keys » : ["user_id », « user_address"]}, « options » : {"unique » : « true"}] ».
La ressource de débit maximale peut être mise à l’échelle vers (RU/s). Fourni lorsque la ressource est activée automatiquement. La valeur minimale peut être 4 000 (RU/s).
Chemin de la clé de partitionnement.
Débit de la collection MongoDB (RU/s). La valeur par défaut est 400. Omettez ce paramètre si la base de données a un débit partagé, sauf si la collection doit avoir un débit dédié.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection delete
Supprimez la collection MongoDB sous une base de données MongoDB Azure Cosmos DB.
az cosmosdb mongodb collection delete --account-name
--database-name
--name
--resource-group
[--yes]
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
N’invitez pas à confirmer.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection exists
Vérifie si une collection MongoDB Azure Cosmos DB existe.
az cosmosdb mongodb collection exists --account-name
--database-name
--name
--resource-group
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection list
Répertoriez les collections MongoDB sous une base de données MongoDB Azure Cosmos DB.
az cosmosdb mongodb collection list --account-name
--database-name
--resource-group
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection merge
Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus
Fusionne les partitions d’une collection mongodb.
az cosmosdb mongodb collection merge --account-name
--database-name
--name
--resource-group
Exemples
fusionner des partitions de collection my-mongodb-collection
az cosmosdb mongodb collection merge -g my-resource-group -a my-account -d my-db --name my-mongodb-collection
Paramètres obligatoires
Nom du compte de base de données CosmosDB.
Nom de la base de données mongoDB.
Nom de la collection mongoDB.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection redistribute-partition-throughput
Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus
Redistribue le débit de partition d’une collection mongodb.
az cosmosdb mongodb collection redistribute-partition-throughput --account-name
--database-name
--name
--resource-group
[--evenly-distribute {false, true}]
[--source-partition-info]
[--target-partition-info]
Exemples
Distribue uniformément le débit de partition pour une collection mongodb parmi toutes les partitions physiques
az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name --resource-group rg_name --evenly-distribute
Redistribue le débit de partition pour une collection mongodb à partir de partitions sources vers des partitions cibles
az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name --resource-group rg_name --target-partition-info 8=1200 6=1200' --source-partition-info 9'
Paramètres obligatoires
Nom du compte de base de données CosmosDB.
Nom de la base de données CosmosDB.
Nom de la collection CosmosDB.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
Basculez pour distribuer le débit de façon égale entre toutes les partitions physiques.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
| Valeurs acceptées: | false, true |
Ids de partition physique source séparés par espace, par exemple : 1 2.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | [] |
Informations sur le débit de partition physique cible souhaité, par exemple : « 0=1200 1 =1200 ».
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | [] |
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection restore
Restaurez une collection mongodb supprimée dans le même compte.
az cosmosdb mongodb collection restore --account-name
--database-name
--name
--resource-group
[--disable-ttl]
[--restore-timestamp]
Exemples
Restaurez une collection mongodb supprimée dans le même compte.
az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
Indicateur de restauration avec la durée de vie désactivée.
Utilisation : --disable-ttl True Default : false.
Horodatage dans lequel la collection doit être restaurée.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection restore (cosmosdb-preview extension)
Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus
Restaurez une collection mongodb supprimée dans le même compte.
az cosmosdb mongodb collection restore --account-name
--database-name
--name
--resource-group
[--disable-ttl {false, true}]
[--restore-timestamp]
Exemples
Restaurez une collection mongodb supprimée dans le même compte.
az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
Activez ou désactivez la restauration avec la durée de vie désactivée.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | false, true |
Horodatage dans lequel la collection doit être restaurée.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection retrieve-partition-throughput
Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus
Récupérez le débit de partition d’une collection mongodb.
az cosmosdb mongodb collection retrieve-partition-throughput --account-name
--database-name
--name
--resource-group
[--all-partitions {false, true}]
[--physical-partition-ids]
Exemples
Récupérer le débit de container_name du conteneur pour des partitions physiques spécifiques
az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name --resource-group rg_name --physical-partition-ids 8 9
Récupérer le débit du container_name de conteneur pour toutes les partitions physiques
az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name --resource-group rg_name --all-partitions
Paramètres obligatoires
Nom du compte de base de données CosmosDB.
Nom de la base de données CosmosDB.
Nom du conteneur CosmosDB.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
Basculez pour récupérer le débit pour toutes les partitions physiques.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
| Valeurs acceptées: | false, true |
Liste séparée par l’espace des ID de partition physique.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | [] |
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection show
Affichez les détails d’une collection MongoDB sous une base de données MongoDB Azure Cosmos DB.
az cosmosdb mongodb collection show --account-name
--database-name
--name
--resource-group
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
az cosmosdb mongodb collection update
Mettez à jour une collection MongoDB sous une base de données MongoDB Azure Cosmos DB.
az cosmosdb mongodb collection update --account-name
--database-name
--name
--resource-group
[--analytical-storage-ttl]
[--idx]
Paramètres obligatoires
Nom du compte Cosmosdb.
Nom de la base de données.
Nom de la collection.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres facultatifs
Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.
Durée de vie analytique, lorsque le stockage analytique est activé.
Index, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, Par exemple, --idx @indexes-file.json ou --idx « [{"key » : {"keys » : ["_ts"]},"options » : {"expireAfterSeconds » : 1000}}, {"key » : {"keys » : ["user_id », « user_address"]}, « options » : {"unique » : « true"}] ».
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |