Namespaces - List Keys

服務:

Notification Hubs

API 版本:

2023-09-01

取得命名空間的主要和次要 ConnectionStrings。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2023-09-01

URI 參數

名稱	位於	必要	類型	Description
authorizationRuleName	path	True	string minLength: 1 maxLength: 256 pattern: ^[a-zA-Z0-9!()*-._]+$	授權規則名稱
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	命名空間名稱
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	ResourceListKeys	成功
Other Status Codes	ErrorResponse	有原因的錯誤碼。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

範圍

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

範例

Namespaces_ListKeys

範例要求

HTTP

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/RootManageSharedAccessKey/listKeys?api-version=2023-09-01

範例回覆

狀態碼:

200

{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "RootManageSharedAccessKey"
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ResourceListKeys	會傳回命名空間或 NotificationHub 存取金鑰之 POST 要求的回應（連接字串）。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細數據。

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

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ResourceListKeys

Object

會傳回命名空間或 NotificationHub 存取金鑰之 POST 要求的回應（連接字串）。

名稱	類型	Description
keyName	string	取得或設定所建立 AuthorizationRule 的 keyName
primaryConnectionString	string	取得或設定 AuthorizationRule 的 primaryConnectionString。
primaryKey	string	取得或設定所建立 AuthorizationRule 的 primaryKey。
secondaryConnectionString	string	取得或設定所建立 AuthorizationRule 的 secondaryConnectionString
secondaryKey	string	取得或設定所建立 AuthorizationRule 的 secondaryKey