SignalR - List Keys

服務:

SignalR Service

API 版本:

2024-03-01

取得資源的存取金鑰。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys?api-version=2024-03-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
resourceName	path	True	string	資源名稱。 Regex 模式: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	SignalRKeys	成功。 回應描述資源的存取金鑰。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

SignalR_ListKeys

範例要求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/signalR/mySignalRService/listKeys?api-version=2024-03-01

範例回覆

狀態碼:

200

{}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
SignalRKeys	類別代表資源的存取金鑰。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

SignalRKeys

類別代表資源的存取金鑰。

名稱	類型	Description
primaryConnectionString	string	透過 primaryKey 建構的連接字串
primaryKey	string	主要存取金鑰。
secondaryConnectionString	string	透過 secondaryKey 建構的連接字串
secondaryKey	string	次要存取金鑰。