Trabajo con claves de cuenta y cadenas de conexión para una cuenta de Azure Cosmos DB con la CLI de Azure
SE APLICA A: 
NoSQL MongoDB Cassandra Gremlin Table
En el script de este artículo, se muestran cuatro operaciones.
- Enumeración de todas las claves de cuenta
- Enumeración de claves de cuenta de solo lectura
- Enumeración de cadenas de conexión
- Regeneración de claves de cuenta
Este script usa una cuenta de la API para NoSQL, pero estas operaciones son idénticas en todas las API de base de datos en Azure Cosmos DB.
Si no tiene una suscripción a Azure, cree una cuenta gratuita de Azure antes de empezar.
Requisitos previos
Use el entorno de Bash en Azure Cloud Shell. Para más información, consulte Inicio rápido para Bash en Azure Cloud Shell.
Si prefiere ejecutar comandos de referencia de la CLI localmente, instale la CLI de Azure. Si utiliza Windows o macOS, considere la posibilidad de ejecutar la CLI de Azure en un contenedor Docker. Para más información, vea Ejecución de la CLI de Azure en un contenedor de Docker.
Si usa una instalación local, inicie sesión en la CLI de Azure mediante el comando az login. Siga los pasos que se muestran en el terminal para completar el proceso de autenticación. Para ver otras opciones de inicio de sesión, consulte Inicio de sesión con la CLI de Azure.
En caso de que se le solicite, instale las extensiones de la CLI de Azure la primera vez que la use. Para más información sobre las extensiones, consulte Uso de extensiones con la CLI de Azure.
Ejecute az version para buscar cuál es la versión y las bibliotecas dependientes que están instaladas. Para realizar la actualización a la versión más reciente, ejecute az upgrade.
- En este artículo se necesita la versión 2.9.1 de la CLI de Azure o cualquier versión posterior. Si usa Azure Cloud Shell, ya está instalada la versión más reciente.
Script de ejemplo
Inicio de Azure Cloud Shell
Azure Cloud Shell es un shell interactivo gratuito que puede usar para ejecutar los pasos de este artículo. Tiene las herramientas comunes de Azure preinstaladas y configuradas para usarlas en la cuenta.
Para abrir Cloud Shell, seleccione Pruébelo en la esquina superior derecha de un bloque de código. También puede ir a https://shell.azure.com para iniciar Cloud Shell en una pestaña independiente del explorador.
Cuando se abra Cloud Shell, compruebe que Bash está seleccionado para el entorno. En las sesiones siguientes se usará la CLI de Azure en un entorno de Bash, seleccione Copiar para copiar los bloques de código, péguelos en Cloud Shell y, luego, presione Entrar para ejecutarlos.
Inicio de sesión en Azure
Cloud Shell se autentica de forma automática en la cuenta inicial con la que ha iniciado sesión. Use el script siguiente para iniciar sesión con otra suscripción, y reemplace <Subscription ID> con el id. de la suscripción de Azure. Si no tiene una suscripción a Azure, cree una cuenta gratuita de Azure antes de empezar.
subscription="<subscriptionId>" # add subscription here
az account set -s $subscription # ...or use 'az login'
Para más información, vea Establecimiento de la suscripción activa o Inicio de sesión de forma interactiva
Ejecute el 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
Limpieza de recursos
Use el comando siguiente para quitar el grupo de recursos y todos los recursos asociados con él mediante el comando az group delete, a menos que tenga una necesidad constante de estos recursos. Algunos de estos recursos pueden tardar un tiempo en crearse, así como en eliminarse.
az group delete --name $resourceGroup
Referencia de ejemplo
Este script usa los siguientes comandos. Cada comando de la tabla crea un vínculo a documentación específica del comando.
| Get-Help | Notas |
|---|---|
| az group create | Crea un grupo de recursos en el que se almacenan todos los recursos. |
| az cosmosdb create | Crea una cuenta de Azure Cosmos DB. |
| az cosmosdb keys list | Enumera las claves para una cuenta de Azure Cosmos DB. |
| az cosmosdb list-read-only-keys | Enumera las claves de solo lectura de una cuenta de Azure Cosmos DB. |
| az cosmosdb list-connection-strings | Enumera las cadenas de conexión de una cuenta de Azure Cosmos DB. |
| az cosmosdb regenerate-key | Regenera las claves de una cuenta de Azure Cosmos DB. |
| az group delete | Elimina un grupo de recursos, incluidos todos los recursos anidados. |
Pasos siguientes
Para más información, consulte la documentación de la CLI de Azure Cosmos DB.
Si desea ver ejemplos de la CLI de Azure para API específicas, consulte: