Database Accounts - List Keys

서비스:

Cosmos DB Resource Provider

API 버전:

2024-11-15

지정된 Azure Cosmos DB 데이터베이스 계정에 대한 액세스 키를 나열합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
accountName	path	True	string	Cosmos DB 데이터베이스 계정 이름입니다. regex 패턴: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	DatabaseAccountListKeysResult	작업이 성공적으로 완료되었습니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

CosmosDBDatabaseAccountListKeys

샘플 요청

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listKeys?api-version=2024-11-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="subid",
    )

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


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/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

샘플 응답

상태 코드:

200

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

정의

DatabaseAccountListKeysResult

지정된 데이터베이스 계정에 대한 액세스 키입니다.

Name	형식	Description
primaryMasterKey	string	기본 읽기/쓰기 키의 Base 64로 인코딩된 값입니다.
primaryReadonlyMasterKey	string	기본 읽기 전용 키의 Base 64로 인코딩된 값입니다.
secondaryMasterKey	string	보조 읽기/쓰기 키의 Base 64로 인코딩된 값입니다.
secondaryReadonlyMasterKey	string	보조 읽기 전용 키의 Base 64로 인코딩된 값입니다.