Event Hubs - Authorization Rules - Regenerate Keys

イベントハブの ACS および SAS 接続文字列を再生成します。

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

URI パラメーター

Name In Required Type Description
authorizationRuleName
path True
  • string

承認規則の名前。

eventHubName
path True
  • string

イベントハブ名

namespaceName
path True
  • string

名前空間の名前

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

要求本文

Name Required Type Description
keyType True

再生成するアクセスキー。

key
  • string

省略可能。指定されたキー値が keytype に設定されている場合、または自動生成されたキー値が keyType に設定されている場合

応答

Name Type Description
200 OK

接続文字列が正常に再生成されました。

Other Status Codes

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

EventHubAuthorizationRuleRegenerateKey

Sample Request

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-1534/regenerateKeys?api-version=2021-06-01-preview
{
  "keyType": "PrimaryKey"
}

Sample Response

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

定義

AccessKeys

Namespace/EventHub 接続文字列

ErrorResponse

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

KeyType

再生成するアクセスキー。

RegenerateAccessKeyParameters

承認規則の再生成操作に指定されたパラメーターは、どのキーをリセットする必要があるかを指定します。

AccessKeys

Namespace/EventHub 接続文字列

Name Type Description
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 ビットのプライマリ キー。

ErrorResponse

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

Name Type Description
code
  • string

エラー コード。

message
  • string

操作が失敗した理由を示すエラー メッセージ。

KeyType

再生成するアクセスキー。

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

承認規則の再生成操作に指定されたパラメーターは、どのキーをリセットする必要があるかを指定します。

Name Type Description
key
  • string

省略可能。指定されたキー値が keytype に設定されている場合、または自動生成されたキー値が keyType に設定されている場合

keyType

再生成するアクセスキー。