Databases - Regenerate Key

RedisEnterprise データベースのアクセス キーを再生成します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey?api-version=2021-03-01

URI パラメーター

Name In Required Type Description
clusterName
path True
  • string

RedisEnterprise クラスターの名前。

databaseName
path True
  • string

データベースの名前。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

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

要求本文

Name Required Type Description
keyType True

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

応答

Name Type Description
200 OK

データベースの新しいアクセス キーを返します

202 Accepted

クラスターの更新操作が開始されました。 更新された状態を取得するには、Azure-AsyncOperationまたは Location ヘッダーの URL を取得します。

Other Status Codes

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

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

RedisEnterpriseDatabasesRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/regenerateKey?api-version=2021-03-01
{
  "keyType": "Primary"
}

Sample Response

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult...

定義

AccessKeys

アクセス キー

AccessKeyType

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

RegenerateKeyParameters

アクセス キー要求を再生成する

AccessKeys

アクセス キー

Name Type Description
primaryKey
  • string

クライアントが認証に使用できる現在の主キー

secondaryKey
  • string

クライアントが認証に使用できる現在のセカンダリ キー

AccessKeyType

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

Name Type Description
Primary
  • string
Secondary
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラー ターゲット。

ErrorResponse

エラー応答

Name Type Description
error

エラー オブジェクト。

RegenerateKeyParameters

アクセス キー要求を再生成する

Name Type Description
keyType

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