Namespaces - List Keys

サービス:

Notification Hubs

API バージョン:

2023-09-01

名前空間への Primary および Secondary ConnectionStrings を取得します。

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

URI パラメーター

名前	/	必須	型	説明
authorizationRuleName	path	True	string	承認規則名 正規表現パターン: ^[a-zA-Z0-9!()*-._]+$
namespaceName	path	True	string	名前空間名 正規表現パターン: ^[a-zA-Z][a-zA-Z0-9-]*$
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId	path	True	string uuid	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ResourceListKeys	名前空間または NotificationHub アクセス キー (接続文字列) を返す POST 要求の応答。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

ResourceListKeys

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

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