共用方式為


Communication Services - List Keys

列出金鑰
取得 CommunicationService 資源的存取金鑰。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/listKeys?api-version=2023-03-31

URI 參數

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

string

CommunicationService 資源的名稱。

Regex 模式: ^[-\w]+$

resourceGroupName
path True

string

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

subscriptionId
path True

string

uuid

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

CommunicationServiceKeys

成功。 回應描述 CommunicationService 存取金鑰。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

範例

List keys

範例要求

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/listKeys?api-version=2023-03-31

範例回覆

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

定義

名稱 Description
CommunicationServiceKeys

類別,表示 CommunicationService 的存取密鑰。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

CommunicationServiceKeys

類別,表示 CommunicationService 的存取密鑰。

名稱 類型 Description
primaryConnectionString

string

CommunicationService 連接字串 透過 primaryKey 建構

primaryKey

string

主要存取金鑰。

secondaryConnectionString

string

CommunicationService 連接字串 透過 secondaryKey 建構

secondaryKey

string

次要存取金鑰。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。