Accounts - List Keys

清單 指定認知服務帳戶的帳戶金鑰。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys?api-version=2023-05-01

URI 參數

名稱 位於 必要 類型 Description
accountName
path True

string

認知服務帳戶的名稱。

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

ApiKeys

傳回回應本文,其中包含資源的訂用帳戶密鑰:key1 用戶端呼叫 API 端點時要驗證的第一個 API 金鑰。

key2 用戶端呼叫 API 端點時要驗證的第二個 API 金鑰。

Other Status Codes

ErrorResponse

描述作業為何失敗的錯誤回應

範例

List Keys

Sample Request

POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/listKeys?api-version=2023-05-01

Sample Response

{
  "key1": "KEY1",
  "key2": "KEY2"
}

定義

名稱 Description
ApiKeys

認知服務帳戶的存取金鑰。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

ApiKeys

認知服務帳戶的存取金鑰。

名稱 類型 Description
key1

string

取得索引鍵 1 的值。

key2

string

取得索引鍵 2 的值。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。