Database Accounts - List Keys

Hizmet:

Cosmos DB Resource Provider

API Sürümü:

2026-03-15

Belirtilen Azure Cosmos DB veritabanı hesabının erişim anahtarlarını listeler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB veritabanı hesap adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	DatabaseAccountListKeysResult	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızı taklit etme

Örnekler

CosmosDBDatabaseAccountListKeys

Örnek isteği

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
DatabaseAccountListKeysResult	Verilen veritabanı hesabının erişim anahtarları.
ErrorResponse	Hata Yanıtı.

DatabaseAccountListKeysResult

Nesne

Verilen veritabanı hesabının erişim anahtarları.

Name	Tür	Description
primaryMasterKey	string	Birincil okuma-yazma anahtarının temel 64 kodlanmış değeri.
primaryReadonlyMasterKey	string	Birincil salt okunur anahtarın temel 64 kodlanmış değeri.
secondaryMasterKey	string	İkincil okuma-yazma anahtarının temel 64 kodlanmış değeri.
secondaryReadonlyMasterKey	string	İkincil salt okunur anahtarın temel 64 kodlanmış değeri.

ErrorResponse

Nesne

Hata Yanıtı.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu gösteren hata iletisi.