Web Pub Sub - Regenerate Key

リソースのアクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey?api-version=2024-03-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

resourceName
path True

string

リソースの名前。

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

subscriptionId
path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
keyType

KeyType

アクセス キーの種類。

応答

名前 説明
200 OK

WebPubSubKeys

Success

202 Accepted

WebPubSubKeys

受け入れられ、非同期操作がバックグラウンドで実行され、新しいキーが有効になります。 応答には、非同期操作の結果を照会するための新しいアクセス キーと Location ヘッダーが含まれています。

ヘッダー

Location: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

WebPubSub_RegenerateKey

要求のサンプル

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/regenerateKey?api-version=2024-03-01

{
  "keyType": "Primary"
}

応答のサンプル

{}
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...
{}

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

KeyType

アクセス キーの種類。

RegenerateKeyParameters

パラメーターは、アクセス キーを再生成する要求を記述します

WebPubSubKeys

クラスは、リソースのアクセス キーを表します。

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

KeyType

アクセス キーの種類。

名前 説明
Primary

string

Salt

string

Secondary

string

RegenerateKeyParameters

パラメーターは、アクセス キーを再生成する要求を記述します

名前 説明
keyType

KeyType

アクセス キーの種類。

WebPubSubKeys

クラスは、リソースのアクセス キーを表します。

名前 説明
primaryConnectionString

string

primaryKey を使用して構築された接続文字列

primaryKey

string

プライマリ アクセス キー。

secondaryConnectionString

string

secondaryKey を介して構築された接続文字列

secondaryKey

string

セカンダリ アクセス キー。