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 參數

名稱	位於	必要	類型	Description
clusterName	path	True	string	Redis Enterprise 叢集的名稱。 名稱長度必須是 1-60 個字元。 允許的字元（A-Z、a-z、0-9）和連字元（-）。 沒有前置或尾端或連續連字元 Regex 模式: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	Redis Enterprise 資料庫的名稱。 Regex 模式: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
keyType	True	AccessKeyType	要重新產生哪些存取金鑰。

回應

名稱	類型	Description
200 OK	AccessKeys	傳回資料庫的新存取金鑰
202 Accepted		叢集更新作業已啟動。 取得 Azure-AsyncOperation 或位置標頭中的 URL，以擷取更新的狀態。 標題 Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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...

定義

名稱	Description
AccessKeys	存取金鑰
AccessKeyType	要重新產生哪些存取金鑰。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
RegenerateKeyParameters	重新產生存取金鑰要求

AccessKeys

存取金鑰

名稱	類型	Description
primaryKey	string	用戶端可用來驗證的目前主鍵
secondaryKey	string	用戶端可用來驗證的目前次要金鑰

AccessKeyType

要重新產生哪些存取金鑰。

名稱	類型	Description
Primary	string
Secondary	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

RegenerateKeyParameters

重新產生存取金鑰要求

名稱	類型	Description
keyType	AccessKeyType	要重新產生哪些存取金鑰。