Databases - Regenerate Key

サービス:

Redis Cache

API バージョン:

2024-10-01

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

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

URI パラメーター

名前	/	必須	型	説明
clusterName	path	True	string	Redis Enterprise クラスターの名前。 名前の長さは 1 ~ 60 文字にする必要があります。 使用できる文字 (A ~ Z、a ~ z、0 ~ 9) とハイフン (-)。 先頭または末尾または連続するハイフンは使用できません 正規表現パターン: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	Redis Enterprise データベースの名前。 正規表現パターン: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
keyType	True	AccessKeyType	再生成するアクセス キー。

応答

名前	型	説明
200 OK	AccessKeys	データベースの新しいアクセス キーを返します
202 Accepted		クラスターの更新操作が開始されました。 更新された状態を取得するには、Azure-AsyncOperation ヘッダーまたは場所ヘッダーの URL を取得します。 ヘッダー Location: string Azure-AsyncOperation: 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	ユーザー アカウントを偽装する

例

RedisEnterpriseDatabasesRegenerateKey

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/regenerateKey?api-version=2024-10-01

{
  "keyType": "Primary"
}

応答のサンプル

状態コード:

200

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

状態コード:

202

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

アクセス キー

名前	型	説明
primaryKey	string	クライアントが認証に使用できる現在の主キー
secondaryKey	string	クライアントが認証に使用できる現在のセカンダリ キー

AccessKeyType

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

名前	型	説明
Primary	string
Secondary	string

ErrorAdditionalInfo

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

RegenerateKeyParameters

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

名前	型	説明
keyType	AccessKeyType	再生成するアクセス キー。