Topics – Authorization Rules - Regenerate Keys

トピックのプライマリ接続文字列またはセカンダリ接続文字列を再生成します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys?api-version=2021-11-01

URI パラメーター

Name In Required Type Description
authorizationRuleName
path True
  • string

承認規則名。

namespaceName
path True
  • string

名前空間名

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

topicName
path True
  • string

トピック名。

api-version
query True
  • string

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

要求本文

Name Required Type Description
keyType True

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

key
  • string

指定されたキー値が KeyType 値に対してリセットされる場合は省略可能、または keyType に設定されたキー値の自動生成

応答

Name Type Description
200 OK

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

Other Status Codes

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

セキュリティ

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 ユーザー アカウントを偽装する

TopicAuthorizationRuleRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace8408/topics/sdk-Topics2075/authorizationRules/sdk-Authrules5067/regenerateKeys?api-version=2021-11-01
{
  "keyType": "PrimaryKey"
}

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984",
  "primaryKey": "#############################################",
  "secondaryKey": "#############################################",
  "keyName": "sdk-AuthRules-4310"
}

定義

AccessKeys

名前空間/ServiceBus 接続文字列

Error

エラー オブジェクト。

ErrorAdditionalInfo

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

ErrorResponse

リソース管理エラー応答。

KeyType

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

RegenerateAccessKeyParameters

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

AccessKeys

名前空間/ServiceBus 接続文字列

Name Type Description
aliasPrimaryConnectionString
  • string

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

aliasSecondaryConnectionString
  • string

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

keyName
  • string

承認規則を説明する文字列。

primaryConnectionString
  • string

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

primaryKey
  • string

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

secondaryConnectionString
  • string

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

secondaryKey
  • string

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

Error

エラー オブジェクト。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラー ターゲット。

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorResponse

リソース管理エラー応答。

Name Type Description
error

エラー オブジェクト。

KeyType

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

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

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

Name Type Description
key
  • string

指定されたキー値が KeyType 値に対してリセットされる場合は省略可能、または keyType に設定されたキー値の自動生成

keyType

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