Compartilhar via


az cosmosdb keys

Gerencie chaves do Azure Cosmos DB.

Comandos

Nome Description Tipo Status
az cosmosdb keys list

Liste as chaves de acesso ou cadeias de conexão para uma conta de banco de dados do Azure Cosmos DB.

Núcleo GA
az cosmosdb keys regenerate

Gere novamente uma chave de acesso para uma conta de banco de dados do Azure Cosmos DB.

Núcleo GA

az cosmosdb keys list

Liste as chaves de acesso ou cadeias de conexão para uma conta de banco de dados do Azure Cosmos DB.

az cosmosdb keys list --name
                      --resource-group
                      [--type {connection-strings, keys, read-only-keys}]

Exemplos

Liste as chaves de acesso ou cadeias de conexão para uma conta de banco de dados do Azure Cosmos DB. (gerado automaticamente)

az cosmosdb keys list --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription --type keys

Parâmetros Exigidos

--name -n

Nome da conta do Cosmosdb.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--type

O tipo de chave de conta.

Valores aceitos: connection-strings, keys, read-only-keys
Valor padrão: keys
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb keys regenerate

Gere novamente uma chave de acesso para uma conta de banco de dados do Azure Cosmos DB.

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Exemplos

Regenere a chave de acesso primaryReadonly para uma conta de banco de dados do Azure Cosmos DB.

az cosmosdb keys regenerate --key-kind primaryReadonly --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

Parâmetros Exigidos

--key-kind

A chave de acesso para regenerar.

Valores aceitos: primary, primaryReadonly, secondary, secondaryReadonly

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da conta de banco de dados do Cosmos DB.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.