Share via

az cosmosdb collection

  • Déprécié
  • Référence

Cette commande a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Gérer les collections Azure Cosmos DB.

Commandes

Nom Description Type Statut
az cosmosdb collection create

Crée une collection Azure Cosmos DB.

 Core Déprécié
az cosmosdb collection delete

Supprime une collection Azure Cosmos DB.

 Core Déprécié
az cosmosdb collection exists

Retourne une valeur booléenne indiquant si la collection existe.

 Core Déprécié
az cosmosdb collection list

Répertorie toutes les collections Azure Cosmos DB.

 Core Déprécié
az cosmosdb collection show

Affiche une collection Azure Cosmos DB et son offre.

 Core Déprécié
az cosmosdb collection update

Mises à jour une collection Azure Cosmos DB.

 Core Déprécié

az cosmosdb collection create

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « cosmosdb collection » est déconseillé et sera supprimé dans une version ultérieure. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Crée une collection Azure Cosmos DB.

az cosmosdb collection create --collection-name
                              --db-name
                              [--cep]
                              [--default-ttl]
                              [--indexing-policy]
                              [--key]
                              [--name]
                              [--partition-key-path]
                              [--resource-group-name]
                              [--throughput]
                              [--url-connection]

Paramètres obligatoires

--collection-name -c

Nom de la collection.

--db-name -d

Nom de la base de données.

Paramètres facultatifs

--cep

Stratégie de chiffrement du client, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --cep ou --cep @policy-file.json « {"includePaths »: [{"path »: « /path1 »,"clientEncryptionKeyId »: « key1 »,"encryptionAlgorithm »: « AEAD_AES_256_CBC_HMAC_SHA256 »,"encryptionType »: « Deterministic"}],"policyFormatVersion »: 2} ».

--default-ttl

Durée de vie par défaut. Indiquez 0 pour désactiver.

--indexing-policy

La stratégie d’indexation vous permet de l’entrer sous la forme d’une chaîne ou d’un fichier, par exemple - --indexing-policy @policy-file.json).

valeur par défaut: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--key

Clé de compte Cosmos DB. Doit être utilisé conjointement avec le nom du compte cosmosdb ou la connexion URL.

--name -n

Nom du compte Cosmos DB. Doit être utilisé conjointement avec le nom du groupe de ressources ou de la clé de compte cosmosdb.

--partition-key-path

Chemin d’accès à la clé de partition, par exemple « /properties/name ».

--resource-group-name -g

Nom du groupe de ressources. Doit être utilisé conjointement avec le nom du compte cosmosdb.

--throughput

Débit de l’offre (RU/s).

--url-connection

Connexion d’URL de compte Cosmos DB. Doit être utilisé conjointement avec la clé de compte cosmosdb.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az cosmosdb collection delete

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « cosmosdb collection » est déconseillé et sera supprimé dans une version ultérieure. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Supprime une collection Azure Cosmos DB.

az cosmosdb collection delete --collection-name
                              --db-name
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--url-connection]
                              [--yes]

Paramètres obligatoires

--collection-name -c

Nom de la collection.

--db-name -d

Nom de la base de données.

Paramètres facultatifs

--key

Clé de compte Cosmos DB. Doit être utilisé conjointement avec le nom du compte cosmosdb ou la connexion URL.

--name -n

Nom du compte Cosmos DB. Doit être utilisé conjointement avec le nom du groupe de ressources ou de la clé de compte cosmosdb.

--resource-group-name -g

Nom du groupe de ressources. Doit être utilisé conjointement avec le nom du compte cosmosdb.

--url-connection

Connexion d’URL de compte Cosmos DB. Doit être utilisé conjointement avec la clé de compte cosmosdb.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az cosmosdb collection exists

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « cosmosdb collection » est déconseillé et sera supprimé dans une version ultérieure. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Retourne une valeur booléenne indiquant si la collection existe.

az cosmosdb collection exists --collection-name
                              --db-name
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--url-connection]

Paramètres obligatoires

--collection-name -c

Nom de la collection.

--db-name -d

Nom de la base de données.

Paramètres facultatifs

--key

Clé de compte Cosmos DB. Doit être utilisé conjointement avec le nom du compte cosmosdb ou la connexion URL.

--name -n

Nom du compte Cosmos DB. Doit être utilisé conjointement avec le nom du groupe de ressources ou de la clé de compte cosmosdb.

--resource-group-name -g

Nom du groupe de ressources. Doit être utilisé conjointement avec le nom du compte cosmosdb.

--url-connection

Connexion d’URL de compte Cosmos DB. Doit être utilisé conjointement avec la clé de compte cosmosdb.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az cosmosdb collection list

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « cosmosdb collection » est déconseillé et sera supprimé dans une version ultérieure. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Répertorie toutes les collections Azure Cosmos DB.

az cosmosdb collection list --db-name
                            [--key]
                            [--name]
                            [--resource-group-name]
                            [--url-connection]

Paramètres obligatoires

--db-name -d

Nom de la base de données.

Paramètres facultatifs

--key

Clé de compte Cosmos DB. Doit être utilisé conjointement avec le nom du compte cosmosdb ou la connexion URL.

--name -n

Nom du compte Cosmos DB. Doit être utilisé conjointement avec le nom du groupe de ressources ou de la clé de compte cosmosdb.

--resource-group-name -g

Nom du groupe de ressources. Doit être utilisé conjointement avec le nom du compte cosmosdb.

--url-connection

Connexion d’URL de compte Cosmos DB. Doit être utilisé conjointement avec la clé de compte cosmosdb.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az cosmosdb collection show

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « cosmosdb collection » est déconseillé et sera supprimé dans une version ultérieure. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Affiche une collection Azure Cosmos DB et son offre.

az cosmosdb collection show --collection-name
                            --db-name
                            [--key]
                            [--name]
                            [--resource-group-name]
                            [--url-connection]

Paramètres obligatoires

--collection-name -c

Nom de la collection.

--db-name -d

Nom de la base de données.

Paramètres facultatifs

--key

Clé de compte Cosmos DB. Doit être utilisé conjointement avec le nom du compte cosmosdb ou la connexion URL.

--name -n

Nom du compte Cosmos DB. Doit être utilisé conjointement avec le nom du groupe de ressources ou de la clé de compte cosmosdb.

--resource-group-name -g

Nom du groupe de ressources. Doit être utilisé conjointement avec le nom du compte cosmosdb.

--url-connection

Connexion d’URL de compte Cosmos DB. Doit être utilisé conjointement avec la clé de compte cosmosdb.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az cosmosdb collection update

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « cosmosdb collection » est déconseillé et sera supprimé dans une version ultérieure. Utilisez plutôt « cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph or cosmosdb table ».

Mises à jour une collection Azure Cosmos DB.

az cosmosdb collection update --collection-name
                              --db-name
                              [--default-ttl]
                              [--indexing-policy]
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--throughput]
                              [--url-connection]

Paramètres obligatoires

--collection-name -c

Nom de la collection.

--db-name -d

Nom de la base de données.

Paramètres facultatifs

--default-ttl

Durée de vie par défaut. Indiquez 0 pour désactiver.

--indexing-policy

La stratégie d’indexation vous permet de l’entrer sous la forme d’une chaîne ou d’un fichier, par exemple - --indexing-policy @policy-file.json).

--key

Clé de compte Cosmos DB. Doit être utilisé conjointement avec le nom du compte cosmosdb ou la connexion URL.

--name -n

Nom du compte Cosmos DB. Doit être utilisé conjointement avec le nom du groupe de ressources ou de la clé de compte cosmosdb.

--resource-group-name -g

Nom du groupe de ressources. Doit être utilisé conjointement avec le nom du compte cosmosdb.

--throughput

Débit de l’offre (RU/s).

--url-connection

Connexion d’URL de compte Cosmos DB. Doit être utilisé conjointement avec la clé de compte cosmosdb.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.