Notification Hubs - List Keys

Service:

Notification Hubs

API Version:

2023-09-01

取得 NotificationHub 的主要和次要 ConnectionStrings

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

URI 參數

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

回應

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

NotificationHubs_ListKeys

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-AuthRules-5800"
}

定義

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ResourceListKeys

傳回命名空間或 NotificationHub 存取金鑰的 POST 要求回應， (連接字串) 。

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