Database Accounts - List Keys

Tjänst:

Cosmos DB Resource Provider

API-version:

2026-03-15

Visar en lista över åtkomstnycklarna för det angivna Azure Cosmos DB-databaskontot.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Namn på Cosmos DB-databaskonto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	DatabaseAccountListKeysResult	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CosmosDBDatabaseAccountListKeys

Exempelbegäran

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

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to lists the access keys for the specified Azure Cosmos DB database account.
 *
 * @summary lists the access keys for the specified Azure Cosmos DB database account.
 * x-ms-original-file: 2026-03-15/CosmosDBDatabaseAccountListKeys.json
 */
async function cosmosDBDatabaseAccountListKeys() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.listKeys("rg1", "ddb1");
  console.log(result);
}

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
DatabaseAccountListKeysResult	Åtkomstnycklarna för det angivna databaskontot.
ErrorResponse	Svar på ett fel.

DatabaseAccountListKeysResult

Objekt

Åtkomstnycklarna för det angivna databaskontot.

Name	Typ	Description
primaryMasterKey	string	Bas 64-kodat värde för den primära läs- och skrivnyckeln.
primaryReadonlyMasterKey	string	Bas 64-kodat värde för den primära skrivskyddade nyckeln.
secondaryMasterKey	string	Bas 64-kodat värde för den sekundära läs- och skrivnyckeln.
secondaryReadonlyMasterKey	string	Bas 64-kodat värde för den sekundära skrivskyddade nyckeln.

ErrorResponse

Objekt

Svar på ett fel.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.