Compartir a través de


Database Accounts - List Keys

Listas las claves de acceso de la cuenta de base de datos de Azure Cosmos DB especificada.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
accountName
path True

string

Nombre de la cuenta de base de datos de Cosmos DB.

Patrón de Regex: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

DatabaseAccountListKeysResult

La operación se ha completado correctamente.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation Suplantación de su cuenta de usuario

Ejemplos

CosmosDBDatabaseAccountListKeys

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

DatabaseAccountListKeysResult

Claves de acceso de la cuenta de base de datos especificada.

Nombre Tipo Description
primaryMasterKey

string

Valor codificado en base 64 de la clave principal de lectura y escritura.

primaryReadonlyMasterKey

string

Valor codificado en base 64 de la clave de solo lectura principal.

secondaryMasterKey

string

Valor codificado en base 64 de la clave secundaria de lectura y escritura.

secondaryReadonlyMasterKey

string

Valor codificado en base 64 de la clave de solo lectura secundaria.