Database Accounts - List Keys
清單 指定之 Azure Cosmos DB 資料庫帳戶的存取密鑰。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys?api-version=2024-05-15
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
account
|
path | True |
string |
Cosmos DB 資料庫帳戶名稱。 Regex pattern: |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
作業已成功完成。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
CosmosDBDatabaseAccountListKeys
Sample Request
Sample Response
{
"primaryMasterKey": "primaryMasterKey",
"secondaryMasterKey": "secondaryMasterKey",
"primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
"secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}
定義
DatabaseAccountListKeysResult
指定資料庫帳戶的存取金鑰。
名稱 | 類型 | Description |
---|---|---|
primaryMasterKey |
string |
主要讀寫金鑰的Base 64編碼值。 |
primaryReadonlyMasterKey |
string |
主要只讀金鑰的Base 64編碼值。 |
secondaryMasterKey |
string |
次要讀寫密鑰的基底 64 編碼值。 |
secondaryReadonlyMasterKey |
string |
次要只讀密鑰的基底 64 編碼值。 |