Partager via

az cosmosdb service

  • Référence

Remarque

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. En savoir plus sur les extensions.

Commandes pour effectuer des opérations sur le service.

Commandes

Nom Description Type État
az cosmosdb service create

Créez une ressource de service cosmosdb.

 Core GA
az cosmosdb service create (cosmosdb-preview extension)

Créez une ressource de service cosmosdb.

 Extension Aperçu
az cosmosdb service delete

Supprimez la ressource de service cosmosdb donnée.

 Core GA
az cosmosdb service delete (cosmosdb-preview extension)

Supprimez la ressource de service cosmosdb donnée.

 Extension Aperçu
az cosmosdb service list

Répertorier toutes les ressources de service cosmosdb sous un compte.

 Core GA
az cosmosdb service list (cosmosdb-preview extension)

Répertorier toutes les ressources de service cosmosdb sous un compte.

 Extension Aperçu
az cosmosdb service show

Obtenir la ressource de service cosmosdb sous un compte.

 Core GA
az cosmosdb service show (cosmosdb-preview extension)

Obtenir la ressource de service cosmosdb sous un compte.

 Extension Aperçu
az cosmosdb service update

Mettez à jour une ressource de service cosmosdb.

 Core GA
az cosmosdb service update (cosmosdb-preview extension)

Mettez à jour une ressource de service cosmosdb.

 Extension Aperçu

az cosmosdb service create

Modifier

Créez une ressource de service cosmosdb.

az cosmosdb service create --account-name
                           --name
                           --resource-group-name
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Exemples

Créez une ressource de service cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

Paramètres facultatifs

--count -c

Nombre d’instances.

Valeur par défaut: 1
--gateway-type

Type de passerelle dédiée. Valide uniquement pour le type de service SqlDedicatedGateway.

Valeurs acceptées: DistributedQuery, IntegratedCache
Valeur par défaut: IntegratedCache
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--size

Taille de l’instance. Les valeurs possibles sont : Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

Valeur par défaut: Cosmos.D4s
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 service create (cosmosdb-preview extension)

Préversion

Le groupe de commandes « cosmosdb service » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez une ressource de service cosmosdb.

az cosmosdb service create --account-name
                           --kind
                           --name
                           --resource-group-name
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Exemples

Créez une ressource de service cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Créez une ressource de service de générateur de vues matérialisées cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3 --size "Cosmos.D4s"

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--kind -k

Type de service.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

Paramètres facultatifs

--count -c

Nombre d’instances.

Valeur par défaut: 1
--gateway-type

Type de passerelle dédiée. Valide uniquement pour le type de service SqlDedicatedGateway.

Valeurs acceptées: DistributedQuery, IntegratedCache
Valeur par défaut: IntegratedCache
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--size

Taille de l’instance. Les valeurs possibles sont : Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

Valeur par défaut: Cosmos.D4s
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 service delete

Modifier

Supprimez la ressource de service cosmosdb donnée.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Exemples

Supprimez la ressource de service cosmosdb donnée.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--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 service delete (cosmosdb-preview extension)

Préversion

Le groupe de commandes « cosmosdb service » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez la ressource de service cosmosdb donnée.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Exemples

Supprimez la ressource de service cosmosdb donnée.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Supprimez la ressource de service du générateur de vues matérialisées cosmosdb.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder"

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--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 service list

Modifier

Répertorier toutes les ressources de service cosmosdb sous un compte.

az cosmosdb service list --account-name
                         --resource-group-name

Exemples

Répertorier toutes les ressources de service cosmosdb sous un compte.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

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 service list (cosmosdb-preview extension)

Préversion

Le groupe de commandes « cosmosdb service » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Répertorier toutes les ressources de service cosmosdb sous un compte.

az cosmosdb service list --account-name
                         --resource-group-name

Exemples

Répertorier toutes les ressources de service cosmosdb sous un compte.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

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 service show

Modifier

Obtenir la ressource de service cosmosdb sous un compte.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Exemples

Obtenir la ressource de service cosmosdb sous un compte.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

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 service show (cosmosdb-preview extension)

Préversion

Le groupe de commandes « cosmosdb service » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Obtenir la ressource de service cosmosdb sous un compte.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Exemples

Obtenir la ressource de service cosmosdb sous un compte.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

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 service update

Modifier

Mettez à jour une ressource de service cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Exemples

Mettez à jour une ressource de service cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--count -c

Nombre d’instances.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--size

Taille de l’instance. Les valeurs possibles sont : Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

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

Préversion

Le groupe de commandes « cosmosdb service » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour une ressource de service cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --kind
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Exemples

Mettez à jour une ressource de service cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3

Mettez à jour une ressource de service de générateur de vues matérialisées cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3

Paramètres obligatoires

--account-name -a

Nom du compte de base de données Cosmos DB.

--count -c

Nombre d’instances.

--kind -k

Type de service.

--name -n

Nom du service.

--resource-group-name -g

Nom du groupe de ressources du compte de base de données.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--size

Taille de l’instance. Les valeurs possibles sont : Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

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.