Database Accounts - List Keys

Service:

Cosmos DB Resource Provider

Version d’API:

2026-03-15

Répertorie les clés d’accès pour le compte de base de données Azure Cosmos DB spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nom du compte de base de données Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DatabaseAccountListKeysResult	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Usurper l’identité de votre compte utilisateur

Exemples

CosmosDBDatabaseAccountListKeys

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listKeys?api-version=2026-03-15

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_database_account_list_keys.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_accounts.list_keys(
        resource_group_name="rg1",
        account_name="ddb1",
    )
    print(response)


# x-ms-original-file: 2026-03-15/CosmosDBDatabaseAccountListKeys.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
DatabaseAccountListKeysResult	Clés d’accès pour le compte de base de données donné.
ErrorResponse	Réponse d’erreur.

DatabaseAccountListKeysResult

Objet

Clés d’accès pour le compte de base de données donné.

Nom	Type	Description
primaryMasterKey	string	Valeur encodée en base 64 de la clé de lecture-écriture primaire.
primaryReadonlyMasterKey	string	Valeur encodée en base 64 de la clé en lecture seule primaire.
secondaryMasterKey	string	Valeur encodée en base 64 de la clé en lecture-écriture secondaire.
secondaryReadonlyMasterKey	string	Valeur encodée en base 64 de la clé en lecture seule secondaire.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.