Notification Hubs - Regenerate Keys

リファレンス

Service:: Notification Hubs

API Version:: 2023-09-01

NotificationHub 承認規則に対するプライマリ/セカンダリキーを再生成します

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

URI パラメーター

名前	/	必須	型	説明
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	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
policyKey	True	PolicyKeyType	共有アクセスポリシーキーの種類 (プライマリまたはセカンダリ)。

応答

名前	型	説明
200 OK	ResourceListKeys	Success
Other Status Codes	ErrorResponse	理由を含むエラーコード。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

NotificationHubs_RegenerateKeys

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/DefaultListenSharedAccessSignature/regenerateKeys?api-version=2023-09-01

{
  "policyKey": "PrimaryKey"
}

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": "DefaultListenSharedAccessSignature"
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PolicyKeyResource	名前空間/NotificationHub のキー再生成要求。
PolicyKeyType	共有アクセスポリシーキーの種類 (プライマリまたはセカンダリ)。
ResourceListKeys	名前空間または NotificationHub アクセスキー (接続文字列) を返す POST 要求の応答。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

PolicyKeyResource

名前空間/NotificationHub のキー再生成要求。

名前	型	説明
policyKey	PolicyKeyType	共有アクセスポリシーキーの種類 (プライマリまたはセカンダリ)。

PolicyKeyType

共有アクセスポリシーキーの種類 (プライマリまたはセカンダリ)。

名前	型	説明
PrimaryKey	string
SecondaryKey	string

ResourceListKeys

名前空間または NotificationHub アクセスキー (接続文字列) を返す POST 要求の応答。

名前	型	説明
keyName	string	作成された AuthorizationRule の keyName を取得または設定します
primaryConnectionString	string	AuthorizationRule の primaryConnectionString を取得または設定します。
primaryKey	string	作成された AuthorizationRule の primaryKey を取得または設定します。
secondaryConnectionString	string	作成された AuthorizationRule の secondaryConnectionString を取得または設定します
secondaryKey	string	作成された AuthorizationRule の secondaryKey を取得または設定します

Share via