次の方法で共有


Authorization Rules - Event Hubs - List Keys

イベント ハブの ACS 接続文字列と SAS 接続文字列を取得します。

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

URI パラメーター

名前 / 必須 説明
authorizationRuleName
path True

string

承認規則の名前。

eventHubName
path True

string

イベント ハブ名

namespaceName
path True

string

名前空間名

正規表現パターン: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Azure サブスクリプション内のリソース グループの名前。

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True

string

クライアント API のバージョン。

応答

名前 説明
200 OK

AccessKeys

接続文字列が正常に返されました。

Other Status Codes

ErrorResponse

操作が失敗した理由を説明する Eventhub エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

EventHubAuthorizationRuleListKey

要求のサンプル

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513/listKeys?api-version=2024-01-01

応答のサンプル

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-2513"
}

定義

名前 説明
AccessKeys

Namespace/EventHub 接続文字列

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。

AccessKeys

Namespace/EventHub 接続文字列

名前 説明
aliasPrimaryConnectionString

string

GEO DR が有効になっている場合のエイリアスのプライマリ 接続文字列

aliasSecondaryConnectionString

string

GEO DR が有効になっている場合のエイリアスのセカンダリ 接続文字列

keyName

string

AuthorizationRule を表す文字列。

primaryConnectionString

string

作成された名前空間 AuthorizationRule のプライマリ 接続文字列。

primaryKey

string

SAS トークンの署名と検証用の Base64 でエンコードされた 256 ビットのプライマリ キー。

secondaryConnectionString

string

作成された名前空間 AuthorizationRule のセカンダリ 接続文字列。

secondaryKey

string

SAS トークンの署名と検証用の Base64 でエンコードされた 256 ビットのプライマリ キー。

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。

名前 説明
error

ErrorDetail

error オブジェクト。