Partilhar via

az cosmosdb keys

Gerencie chaves do Azure Cosmos DB.

Comandos

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

 Core disponibilidade geral
az cosmosdb keys regenerate

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

 Core disponibilidade geral

az cosmosdb keys list

Editar

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

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

Parâmetros Obrigatórios

--name -n

Nome da conta 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--type

O tipo de chave de conta.

Propriedade Valor
Default value: keys
Valores aceites: connection-strings, keys, read-only-keys
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb keys regenerate

Editar

Regenere 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 Obrigatórios

--key-kind

A chave de acesso para regenerar.

Propriedade Valor
Valores aceites: primary, primaryReadonly, secondary, secondaryReadonly

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome da conta de banco de dados do Cosmos DB.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False