Namespaces - List Keys

サービス:: Relay

API バージョン:: 2024-01-01

名前空間へのプライマリ接続文字列とセカンダリ接続文字列。

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

URI パラメーター

名前	/	必須	型	説明
authorizationRuleName	path	True	string minLength: 1	承認規則の名前。
namespaceName	path	True	string minLength: 6 maxLength: 50	名前空間名
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AccessKeys	Azure 操作は正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

RelayNameSpaceAuthorizationRuleListKey

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2024-01-01

応答のサンプル

状態コード:: 200

{
  "keyName": "example-RelayAuthRules-01",
  "primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryKey": "############################################"
}

定義

名前	説明
AccessKeys	名前空間/リレー接続文字列
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

AccessKeys

Object

名前空間/リレー接続文字列

名前	型	説明
keyName	string	承認規則を記述する文字列。
primaryConnectionString	string	作成された名前空間承認規則のプライマリ接続文字列。
primaryKey	string	SAS トークンに署名して検証するための base64 でエンコードされた 256 ビットの主キー。
secondaryConnectionString	string	作成された名前空間承認規則のセカンダリ接続文字列。
secondaryKey	string	SAS トークンに署名して検証するための base64 でエンコードされた 256 ビットのセカンダリキー。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

次の方法で共有

Namespaces - List Keys

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

RelayNameSpaceAuthorizationRuleListKey

要求のサンプル

応答のサンプル

定義

AccessKeys

ErrorAdditionalInfo

ErrorDetail

ErrorResponse