Partager via

az cosmosdb sql container

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 conteneurs SQL Azure Cosmos DB.

Commandes

Nom Description Type État
az cosmosdb sql container create

Créez un conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container create (cosmosdb-preview extension)

Créez un conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Extension GA
az cosmosdb sql container delete

Supprimez le conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container exists

Vérifie si un conteneur SQL Azure Cosmos DB existe.

 Core GA
az cosmosdb sql container list

Répertoriez les conteneurs SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container merge

Fusionne les partitions d’un conteneur sql.

 Extension Preview
az cosmosdb sql container redistribute-partition-throughput

Redistribue le débit de partition d’un conteneur SQL.

 Extension Preview
az cosmosdb sql container restore

Restaurez un conteneur SQL supprimé dans le même compte.

 Core GA
az cosmosdb sql container restore (cosmosdb-preview extension)

Restaurez un conteneur SQL supprimé dans le même compte.

 Extension Preview
az cosmosdb sql container retrieve-partition-throughput

Récupérez le débit de partition d’un conteneur sql.

 Extension Preview
az cosmosdb sql container show

Affichez les détails d’un conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container throughput

Gérer le débit du conteneur SQL sous un compte Azure Cosmos DB.

 Cœur et extension GA
az cosmosdb sql container throughput migrate

Migrez le débit du conteneur SQL entre la mise à l’échelle automatique et le provisionnement manuel.

 Core GA
az cosmosdb sql container throughput migrate (cosmosdb-preview extension)

Migrez le débit du conteneur SQL entre la mise à l’échelle automatique et le provisionnement manuel.

 Extension GA
az cosmosdb sql container throughput show

Obtenez le débit du conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container throughput show (cosmosdb-preview extension)

Obtenez le débit du conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Extension GA
az cosmosdb sql container throughput update

Mettez à jour le débit du conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container throughput update (cosmosdb-preview extension)

Mettez à jour le débit du conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Extension GA
az cosmosdb sql container update

Mettez à jour un conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Core GA
az cosmosdb sql container update (cosmosdb-preview extension)

Mettez à jour un conteneur SQL sous une base de données SQL Azure Cosmos DB.

 Extension GA

az cosmosdb sql container create

Modifier

Créez un conteneur SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--cep]
                                 [--conflict-resolution-policy]
                                 [--full-text-policy]
                                 [--idx]
                                 [--max-throughput]
                                 [--partition-key-version]
                                 [--throughput]
                                 [--ttl]
                                 [--unique-key-policy]
                                 [--vector-embeddings]

Exemples

Créez un conteneur SQL Azure Cosmos DB.

az cosmosdb sql container create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyContainer --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--partition-key-path -p

Chemin de la clé de partition, par exemple, « /address/zipcode ».

--resource-group -g

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.

--analytical-storage-ttl -t

Durée de vie analytique, lorsque le stockage analytique est activé.

--cep

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

--conflict-resolution-policy -c

Stratégie de résolution des conflits, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --conflict-resolution-policy @policy-file.json ou --conflict-resolution-policy « {"mode » : « lastWriterWins », « conflictResolutionPath » : « /path"} ».

--full-text-policy

Stratégie de texte intégral, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, par exemple --full-text-policy @policy-file.json ou --full-text-policy « {"fullTextPaths » : [{"path » : « /ftPath1 », « language » : "en-US" }]} « .

--idx

Stratégie d’indexation, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --idx @policy-file.json ou --idx « {"indexingMode » : « consistent », « automatic » : true, « includedPaths » : [{"path » : « /*"}], « excludedPaths » : [{ « path » : « /headquarters/employees/ ?"}, { « path » : « /\"_etag\"/ ?"}],"vectorIndexes » : [{"path » : « /vector1 »,"type » : « flat"}]} ».

Propriété Valeur
Valeur par défaut: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--max-throughput

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).

--partition-key-version

Version de la clé de partition.

--throughput

Débit du conteneur SQL (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 le conteneur doit avoir un débit dédié.

--ttl

Durée de vie par défaut. Si la valeur est manquante ou définie sur « -1 », les éléments n’expirent pas. Si la valeur est définie sur « n », les éléments expirent « n » secondes après la dernière modification.

--unique-key-policy -u

Stratégie de clé unique, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple , --unique-key-policy @policy-file.json ou --unique-key-policy « {"uniqueKeys » : [{"path » : ["/path/to/key1"]}, {"path » : ["/path/to/key2"]} ».

--vector-embeddings

Stratégie d’incorporation de vecteurs, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --vector-embeddings @policy-file.json ou --vector-embeddings « {"vectorEmbeddings » : [{"path » : « /vector1 », « dataType » : « float32 », « dimensions » : 2, « distanceFunction » : « dotproduct » }]} ».

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container create (cosmosdb-preview extension)

Créez un conteneur SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--cep]
                                 [--conflict-resolution-policy]
                                 [--idx]
                                 [--materialized-view-definition]
                                 [--max-throughput]
                                 [--partition-key-version]
                                 [--throughput]
                                 [--ttl]
                                 [--unique-key-policy]

Exemples

Créez un conteneur SQL Azure Cosmos DB.

az cosmosdb sql container create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyContainer --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--partition-key-path -p

Chemin de la clé de partition, par exemple, « /address/zipcode ».

--resource-group -g

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.

--analytical-storage-ttl -t

Durée de vie analytique, lorsque le stockage analytique est activé.

--cep

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

--conflict-resolution-policy -c

Stratégie de résolution des conflits, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, par exemple --conflict-resolution-policy @policy-file.json ou --conflict-resolution-policy « { « mode » : « lastWriterWins », « conflictResolutionPath » : « /path » } ».

--idx

Stratégie d’indexation, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, Par exemple, --idx @policy-file.json ou --idx « { « indexingMode » : « consistent », « automatic » : true, « includedPaths » : [{"path » : « /*"}], « excludedPaths » : [{ « path » : « /headquarters/employees/ ?"}, { « path » : « /\"_etag\\"/ ?"} } ».

Propriété Valeur
Valeur par défaut: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--materialized-view-definition -m

Définition de vue matérialisée, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --materialized-view-definition @materializedview-definition-file.json ou --materialized-view-definition -m '{ « sourceCollectionId » : « MySourceCollectionName », « definition » : « SELECT * FROM root r"}'.

--max-throughput

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).

--partition-key-version

Version de la clé de partition.

--throughput

Débit du conteneur SQL (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 le conteneur doit avoir un débit dédié.

--ttl

Durée de vie par défaut. Si la valeur est manquante ou définie sur « -1 », les éléments n’expirent pas. Si la valeur est définie sur « n », les éléments expirent « n » secondes après la dernière modification.

--unique-key-policy -u

Stratégie de clé unique, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple ,-unique-key-policy @policy-file.json ou --unique-key-policy « { « uniqueKeys » : [{"path » : ["/path/to/key1"]}, {"path » : ["/path/to/key2"]} ».

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container delete

Modifier

Supprimez le conteneur SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container delete --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--yes]

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

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.

--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container exists

Modifier

Vérifie si un conteneur SQL Azure Cosmos DB existe.

az cosmosdb sql container exists --account-name
                                 --database-name
                                 --name
                                 --resource-group

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container list

Modifier

Répertoriez les conteneurs SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container list --account-name
                               --database-name
                               --resource-group

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container merge

Préversion

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’un conteneur sql.

az cosmosdb sql container merge --account-name
                                --database-name
                                --name
                                --resource-group

Exemples

fusionner des partitions de conteneur my-container

az cosmosdb sql container merge -g my-resource-group -a my-account -d my-db --name my-container

Paramètres obligatoires

--account-name -a

Nom du compte de base de données CosmosDB.

--database-name -d

Nom de la base de données CosmosDB.

--name -n

Nom de la collection CosmosDB.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container redistribute-partition-throughput

Préversion

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’un conteneur SQL.

az cosmosdb sql container 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 un conteneur SQL parmi toutes les partitions physiques

az cosmosdb sql container 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 un conteneur SQL à partir de partitions sources vers des partitions cibles

az cosmosdb sql container 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

--account-name -a

Nom du compte de base de données CosmosDB.

--database-name -d

Nom de la base de données CosmosDB.

--name -n

Nom de la collection CosmosDB.

--resource-group -g

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.

--evenly-distribute

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
--source-partition-info

Ids de partition physique source séparés par espace, par exemple : 1 2.

Propriété Valeur
Valeur par défaut: []
--target-partition-info

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
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container restore

Modifier

Restaurez un conteneur SQL supprimé dans le même compte.

az cosmosdb sql container restore --account-name
                                  --database-name
                                  --name
                                  --resource-group
                                  [--disable-ttl]
                                  [--restore-timestamp]

Exemples

Restaurez un conteneur SQL supprimé dans le même compte.

az cosmosdb sql container restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_container_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

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.

--disable-ttl

Indicateur de restauration avec la durée de vie désactivée.

Utilisation : --disable-ttl True Default : false.

--restore-timestamp -t

Horodatage dans lequel le conteneur doit être restauré.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container restore (cosmosdb-preview extension)

Préversion

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 un conteneur SQL supprimé dans le même compte.

az cosmosdb sql container restore --account-name
                                  --database-name
                                  --name
                                  --resource-group
                                  [--disable-ttl {false, true}]
                                  [--restore-timestamp]

Exemples

Restaurez un conteneur SQL supprimé dans le même compte.

az cosmosdb sql container restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_container_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

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.

--disable-ttl
Préversion

Activez ou désactivez la restauration avec la durée de vie désactivée.

Propriété Valeur
Valeurs acceptées: false, true
--restore-timestamp -t

Horodatage dans lequel le conteneur doit être restauré.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container retrieve-partition-throughput

Préversion

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’un conteneur sql.

az cosmosdb sql container 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 sql container 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 sql container retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --all-partitions

Paramètres obligatoires

--account-name -a

Nom du compte de base de données CosmosDB.

--database-name -d

Nom de la base de données CosmosDB.

--name -n

Nom du conteneur CosmosDB.

--resource-group -g

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.

--all-partitions

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
--physical-partition-ids -p

Liste séparée par l’espace des ID de partition physique.

Propriété Valeur
Valeur par défaut: []
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container show

Modifier

Affichez les détails d’un conteneur SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container show --account-name
                               --database-name
                               --name
                               --resource-group

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container update

Modifier

Mettez à jour un conteneur SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--full-text-policy]
                                 [--idx]
                                 [--ttl]
                                 [--vector-embeddings]

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

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.

--analytical-storage-ttl -t

Durée de vie analytique, lorsque le stockage analytique est activé.

--full-text-policy

Stratégie de texte intégral, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, par exemple --full-text-policy @policy-file.json ou --full-text-policy « {"fullTextPaths » : [{"path » : « /ftPath1 », « language » : "en-US" }]} « .

--idx

Stratégie d’indexation, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --idx @policy-file.json ou --idx « {"indexingMode » : « consistent », « automatic » : true, « includedPaths » : [{"path » : « /*"}], « excludedPaths » : [{ « path » : « /headquarters/employees/ ?"}, { « path » : « /\"_etag\"/ ?"}],"vectorIndexes » : [{"path » : « /vector1 »,"type » : « flat"}]} ».

--ttl

Durée de vie par défaut. Si la valeur est manquante ou définie sur « -1 », les éléments n’expirent pas. Si la valeur est définie sur « n », les éléments expirent « n » secondes après la dernière modification.

--vector-embeddings

Stratégie d’incorporation de vecteurs, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --vector-embeddings @policy-file.json ou --vector-embeddings « {"vectorEmbeddings » : [{"path » : « /vector1 », « dataType » : « float32 », « dimensions » : 2, « distanceFunction » : « dotproduct » }]} ».

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 sql container update (cosmosdb-preview extension)

Mettez à jour un conteneur SQL sous une base de données SQL Azure Cosmos DB.

az cosmosdb sql container update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--idx]
                                 [--materialized-view-definition]
                                 [--ttl]

Paramètres obligatoires

--account-name -a

Nom du compte Cosmosdb.

--database-name -d

Nom de la base de données.

--name -n

Nom du conteneur.

--resource-group -g

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.

--analytical-storage-ttl -t

Durée de vie analytique, lorsque le stockage analytique est activé.

--idx

Stratégie d’indexation, vous pouvez l’entrer en tant que chaîne ou en tant que fichier, Par exemple, --idx @policy-file.json ou --idx « { « indexingMode » : « consistent », « automatic » : true, « includedPaths » : [{"path » : « /*"}], « excludedPaths » : [{ « path » : « /headquarters/employees/ ?"}, { « path » : « /\"_etag\\"/ ?"} } ».

--materialized-view-definition -m

Définition de vue matérialisée, vous pouvez l’entrer sous forme de chaîne ou de fichier, par exemple --materialized-view-definition @materializedview-definition-file.json ou --materialized-view-definition -m '{ « sourceCollectionId » : « MySourceCollectionName », « definition » : « SELECT * FROM root r"}'.

--ttl

Durée de vie par défaut. Si la valeur est manquante ou définie sur « -1 », les éléments n’expirent pas. Si la valeur est définie sur « n », les éléments expirent « n » secondes après la dernière modification.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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