Partilhar via


Database Accounts - List Keys

Lista as chaves de acesso para a conta de banco de dados do Azure Cosmos DB especificada.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys?api-version=2024-11-15

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
path True

string

Nome da conta do banco de dados do Cosmos DB.

Padrão Regex: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

Respostas

Name Tipo Description
200 OK

DatabaseAccountListKeysResult

A operação foi concluída com êxito.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation Personificar a sua conta de utilizador

Exemplos

CosmosDBDatabaseAccountListKeys

Pedido de amostra

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listKeys?api-version=2024-11-15

Resposta da amostra

{
  "primaryMasterKey": "primaryMasterKey",
  "secondaryMasterKey": "secondaryMasterKey",
  "primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
  "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}

Definições

DatabaseAccountListKeysResult

As chaves de acesso para a conta de banco de dados fornecida.

Name Tipo Description
primaryMasterKey

string

Valor codificado de base 64 da chave primária de leitura-gravação.

primaryReadonlyMasterKey

string

Valor codificado de base 64 da chave primária somente leitura.

secondaryMasterKey

string

Valor codificado base 64 da chave de leitura-gravação secundária.

secondaryReadonlyMasterKey

string

Valor codificado base 64 da chave secundária somente leitura.