Database Accounts - List Keys

Tjänst:: Cosmos DB Resource Provider

API-version:: 2025-04-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=2025-04-15

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB-databaskontonamn.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
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	Åtgärden har slutförts.

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/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listKeys?api-version=2025-04-15

Exempelsvar

Statuskod:: 200

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

Definitioner

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.

Dela via