Utiliser des clés de compte et des chaînes de connexion pour un compte Azure Cosmos DB avec Azure CLI
S’APPLIQUE À : 
NoSQL MongoDB Cassandra Gremlin Table
Le script dans cet article illustre quatre opérations.
- Lister toutes clés de compte
- Lister les clés de compte en lecture seule
- Répertorier les chaînes de connexion
- Regénérer les clés de compte
Ce script montre des exemples liés à Azure Cosmos DB for NoSQL, mais ces opérations sont identiques pour toutes les API de base de données d’Azure Cosmos DB.
Si vous n’avez pas d’abonnement Azure, créez un compte gratuit Azure avant de commencer.
Prérequis
Utilisez l’environnement Bash dans Azure Cloud Shell. Pour plus d’informations, consultez Démarrage rapide pour Bash dans Azure Cloud Shell.
Si vous préférez exécuter les commandes de référence de l’interface de ligne de commande localement, installez l’interface Azure CLI. Si vous exécutez sur Windows ou macOS, envisagez d’exécuter Azure CLI dans un conteneur Docker. Pour plus d’informations, consultez Guide pratique pour exécuter Azure CLI dans un conteneur Docker.
Si vous utilisez une installation locale, connectez-vous à Azure CLI à l’aide de la commande az login. Pour finir le processus d’authentification, suivez les étapes affichées dans votre terminal. Pour connaître les autres options de connexion, consultez Se connecter avec Azure CLI.
Lorsque vous y êtes invité, installez l’extension Azure CLI lors de la première utilisation. Pour plus d’informations sur les extensions, consultez Utiliser des extensions avec Azure CLI.
Exécutez az version pour rechercher la version et les bibliothèques dépendantes installées. Pour effectuer une mise à niveau vers la dernière version, exécutez az upgrade.
- Cet article nécessite la version 2.9.1 ou ultérieure d’Azure CLI. Si vous utilisez Azure Cloud Shell, la version la plus récente est déjà installée.
Exemple de script
Lancement d’Azure Cloud Shell
Azure Cloud Shell est un interpréteur de commandes interactif et gratuit que vous pouvez utiliser pour exécuter les étapes de cet article. Il contient des outils Azure courants préinstallés et configurés pour être utilisés avec votre compte.
Pour ouvrir Cloud Shell, sélectionnez simplement Essayer en haut à droite d’un bloc de code. Vous pouvez aussi lancer Cloud Shell dans un onglet distinct du navigateur en accédant à https://shell.azure.com.
Quand Cloud Shell s’ouvre, vérifiez que Bash est sélectionné pour votre environnement. Les sessions ultérieures utiliseront Azure CLI dans un environnement Bash. Sélectionnez Copier pour copier les blocs de code, collez-les dans Cloud Shell, puis appuyez sur Entrée pour les exécuter.
Connexion à Azure
Cloud Shell est automatiquement authentifié sous le compte initial utilisé pour la connexion. Utilisez le script suivant pour vous connecter avec un autre abonnement, en remplaçant subscriptionId par votre ID d’abonnement Azure.
Si vous n’avez pas d’abonnement Azure, créez un compte gratuit Azure avant de commencer.
subscription="subscriptionId" # Set Azure subscription ID here
az account set -s $subscription # ...or use 'az login'
Pour en savoir plus, reportez-vous à Définir l'abonnement actif ou Se connecter de manière interactive.
Exécuter le script
# Account key operations for an Azure Cosmos account
# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
resourceGroup="msdocs-cosmosdb-rg-$randomIdentifier"
tag="keys-cosmosdb"
account="msdocs-account-cosmos-$randomIdentifier" #needs to be lower case
# Create a resource group
echo "Creating $resourceGroup in $location..."
az group create --name $resourceGroup --location "$location" --tags $tag
# Create a Cosmos DB account with default values
# Use appropriate values for --kind or --capabilities for other APIs
echo "Creating $account for CosmosDB"
az cosmosdb create --name $account --resource-group $resourceGroup
# List all account keys
az cosmosdb keys list --name $account --resource-group $resourceGroup
# List read-only keys
az cosmosdb keys list --name $account --resource-group $resourceGroup --type read-only-keys
# List connection strings
az cosmosdb keys list --name $account --resource-group $resourceGroup --type connection-strings
# Regenerate secondary account keys
# key-kind values: primary, primaryReadonly, secondary, secondaryReadonly
az cosmosdb keys regenerate --name $account --resource-group $resourceGroup --key-kind secondary
Nettoyer les ressources
Utilisez la commande suivante pour supprimer le groupe de ressources et toutes les ressources associées à celui-ci à l’aide de la commande az group delete, sauf si vous avez toujours besoin de ces ressources. La création, ainsi que la suppression, de certaines de ces ressources peut prendre du temps.
az group delete --name $resourceGroup
Informations de référence sur l’exemple
Ce script utilise les commandes suivantes. Chaque commande du tableau renvoie à une documentation spécifique.
| Commande | Notes |
|---|---|
| az group create | Crée un groupe de ressources dans lequel toutes les ressources sont stockées. |
| az cosmosdb create | Crée un compte Azure Cosmos DB. |
| az cosmosdb keys list | Listez les clés pour un compte Azure Cosmos DB. |
| az cosmosdb keys list --type read-only-keys | Listez les clés en lecture seule pour un compte Azure Cosmos DB. |
| az cosmosdb keys list --type connection-strings | Listez les chaînes de connexion pour un compte Azure Cosmos DB. |
| les clés az cosmosdb se régénèrent | Régénérez une clé d’accès pour un compte de base de données Azure Cosmos DB. |
| az group delete | Supprime un groupe de ressources, y compris toutes les ressources imbriquées. |
Étapes suivantes
Pour plus d’informations sur l’interface CLI Azure Cosmos DB, consultez la documentation sur l’interface CLI Azure Cosmos DB.
Pour obtenir des exemples de l’interface Azure CLI pour des API spécifiques, consultez :