次の方法で共有


Communication Services - Regenerate Key

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey?api-version=2023-04-01

URI パラメーター

名前 / 必須 説明
communicationServiceName
path True

string

CommunicationService リソースの名前。

正規表現パターン: ^[-\w]+$

resourceGroupName
path True

string

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

subscriptionId
path True

string

uuid

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

api-version
query True

string

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

要求本文

名前 説明
keyType

KeyType

再生成する keyType。 'primary' または 'secondary' (大文字と小文字は区別されません) である必要があります。

応答

名前 説明
200 OK

CommunicationServiceKeys

キーの再生成要求が正常に完了しました。 応答には新しいキーが含まれています。

Other Status Codes

ErrorResponse

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

Regenerate key

要求のサンプル

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/regenerateKey?api-version=2023-04-01

{
  "keyType": "Primary"
}

応答のサンプル

{
  "primaryKey": "1234",
  "primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}

定義

名前 説明
CommunicationServiceKeys

CommunicationService のアクセス キーを表すクラス。

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

KeyType

再生成する keyType。 'primary' または 'secondary' (大文字と小文字は区別されません) である必要があります。

RegenerateKeyParameters

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

CommunicationServiceKeys

CommunicationService のアクセス キーを表すクラス。

名前 説明
primaryConnectionString

string

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

primaryKey

string

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

secondaryConnectionString

string

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

secondaryKey

string

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

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

KeyType

再生成する keyType。 'primary' または 'secondary' (大文字と小文字は区別されません) である必要があります。

名前 説明
Primary

string

Secondary

string

RegenerateKeyParameters

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

名前 説明
keyType

KeyType

再生成する keyType。 'primary' または 'secondary' (大文字と小文字は区別されません) である必要があります。