Redis Enterprise - Update
更新現有的 Redis Enterprise 叢集
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2025-07-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
cluster
|
path | True |
string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ |
Redis Enterprise 叢集的名稱。 名稱長度必須為 1-60 個字元。 允許的字元 (A-Z、a-z、0-9) 和連字號 (-)。 不能有前導、尾隨或連續的連字符 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
資源群組的名稱。 名稱不區分大小寫。 |
|
subscription
|
path | True |
string minLength: 1 |
目標訂用帳戶的標識碼。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| identity |
資源的身分識別。 |
|
| properties.encryption |
叢集的待用加密組態。 |
|
| properties.highAvailability |
默認為啟用。 如果 highAvailability 已停用,則不會復寫數據集。 這會影響可用性 SLA,並增加資料遺失的風險。 |
|
| properties.minimumTlsVersion |
叢集支援的最低 TLS 版本,例如 『1.2』。 未來可以新增較新版本。 請注意,TLS 1.0 和 TLS 1.1 現在已完全過時,您無法使用它們。 只有為了與舊版 API 的一致性,才會提及它們。 |
|
| properties.publicNetworkAccess |
公用網路流量是否可以存取Redis叢集。 只能設定「啟用」或「停用」。 null 只會針對使用舊 API 版本建立的叢集傳回,這些叢集沒有此內容且無法設定。 |
|
| sku |
要建立的 SKU 會影響價格、效能和功能。 |
|
| tags |
object |
資源標籤。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
叢集正在更新。 檢查 provisioningState 和 resourceState 以查看詳細狀態。 |
|
| 202 Accepted |
叢集更新作業已啟動。 GET Azure-AsyncOperation 或位置標頭中的 URL,以擷取更新的狀態。 標題
|
|
| Other Status Codes |
說明作業為何失敗的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
RedisEnterpriseUpdate
範例要求
PATCH https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2025-07-01
{
"sku": {
"name": "EnterpriseFlash_F300",
"capacity": 9
},
"properties": {
"minimumTlsVersion": "1.2",
"publicNetworkAccess": "Enabled"
},
"tags": {
"tag1": "value1"
}
}
範例回覆
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
"name": "cache1",
"type": "Microsoft.Cache/redisEnterprise",
"location": "West US",
"kind": "v1",
"sku": {
"name": "EnterpriseFlash_F300",
"capacity": 9
},
"identity": {
"type": "None"
},
"zones": [
"1",
"2",
"3"
],
"tags": {
"tag1": "value1"
},
"properties": {
"hostName": "cache1.westus.something.azure.com",
"provisioningState": "Updating",
"resourceState": "Updating",
"redisVersion": "5",
"minimumTlsVersion": "1.2",
"publicNetworkAccess": "Enabled"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/providers/Microsoft.Cache/...pathToOperationStatus...
Location: https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/providers/Microsoft.Cache/...pathToOperationResult...
定義
| 名稱 | Description |
|---|---|
| Cluster |
描述 Redis Enterprise 叢集 |
|
Cluster |
Redis Enterprise 叢集的部分更新 |
|
Cmk |
此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型 |
|
Customer |
資源的所有客戶自控金鑰加密屬性。 將此設定為空白物件,以使用Microsoft管理的金鑰加密。 |
| Encryption |
叢集的待用加密組態。 |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細數據。 |
|
Error |
錯誤回應 |
|
High |
默認為啟用。 如果 highAvailability 已停用,則不會復寫數據集。 這會影響可用性 SLA,並增加資料遺失的風險。 |
|
Key |
客戶管理的金鑰設定的所有身分識別組態,定義應用來驗證 Key Vault 的身分識別。 |
| Kind |
區分叢集的類型。 唯讀。 |
|
Managed |
受控服務識別(系統指派和/或使用者指派的身分識別) |
|
Managed |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 |
|
Private |
私人端點資源。 |
|
Private |
私人端點聯機資源。 |
|
Private |
目前的布建狀態。 |
|
Private |
私人端點連線狀態。 |
|
Private |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
Provisioning |
目前的佈建狀態 |
|
Public |
公用網路流量是否可以存取Redis叢集。 只能設定「啟用」或「停用」。 null 只會針對使用舊 API 版本建立的叢集傳回,這些叢集沒有此內容且無法設定。 |
|
Redundancy |
說明叢集目前的備援策略,這會影響預期的 SLA。 |
|
Resource |
目前的資源狀態 |
| Sku |
SKU 參數提供給建立 Redis Enterprise 叢集作業。 |
|
Sku |
要部署的 Redis 企業叢集層級。 可能的值:(『Balanced_B5』、『MemoryOptimized_M10』、『ComputeOptimized_X5』等等)。 如需 SKU 的詳細資訊,請參閱最新的定價檔。 請注意,未來可能會支援其他 SKU。 |
|
Tls |
叢集支援的最低 TLS 版本,例如 『1.2』。 未來可以新增較新版本。 請注意,TLS 1.0 和 TLS 1.1 現在已完全過時,您無法使用它們。 只有為了與舊版 API 的一致性,才會提及它們。 |
|
User |
使用者指派的身分識別屬性 |
Cluster
描述 Redis Enterprise 叢集
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
資源的身分識別。 |
|
| kind |
區分叢集的類型。 唯讀。 |
|
| location |
string |
資源所在的地理位置 |
| name |
string |
資源的名稱 |
| properties.encryption |
叢集的待用加密組態。 |
|
| properties.highAvailability |
默認為啟用。 如果 highAvailability 已停用,則不會復寫數據集。 這會影響可用性 SLA,並增加資料遺失的風險。 |
|
| properties.hostName |
string |
叢集端點的 DNS 名稱 |
| properties.minimumTlsVersion |
叢集支援的最低 TLS 版本,例如 『1.2』。 未來可以新增較新版本。 請注意,TLS 1.0 和 TLS 1.1 現在已完全過時,您無法使用它們。 只有為了與舊版 API 的一致性,才會提及它們。 |
|
| properties.privateEndpointConnections |
與指定 Redis Enterprise 叢集相關聯的私人端點連線清單 |
|
| properties.provisioningState |
叢集目前的佈建狀態 |
|
| properties.publicNetworkAccess |
公用網路流量是否可以存取Redis叢集。 只能設定「啟用」或「停用」。 null 只會針對使用舊 API 版本建立的叢集傳回,這些叢集沒有此內容且無法設定。 |
|
| properties.redisVersion |
string |
叢集支援的redis版本,例如'6' |
| properties.redundancyMode |
說明叢集目前的備援策略,這會影響預期的 SLA。 |
|
| properties.resourceState |
叢集的目前資源狀態 |
|
| sku |
要建立的 SKU 會影響價格、效能和功能。 |
|
| tags |
object |
資源標籤。 |
| type |
string |
資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
| zones |
string[] |
將部署此叢集的可用性區域。 |
ClusterUpdate
Redis Enterprise 叢集的部分更新
| 名稱 | 類型 | Description |
|---|---|---|
| identity |
資源的身分識別。 |
|
| properties.encryption |
叢集的待用加密組態。 |
|
| properties.highAvailability |
默認為啟用。 如果 highAvailability 已停用,則不會復寫數據集。 這會影響可用性 SLA,並增加資料遺失的風險。 |
|
| properties.hostName |
string |
叢集端點的 DNS 名稱 |
| properties.minimumTlsVersion |
叢集支援的最低 TLS 版本,例如 『1.2』。 未來可以新增較新版本。 請注意,TLS 1.0 和 TLS 1.1 現在已完全過時,您無法使用它們。 只有為了與舊版 API 的一致性,才會提及它們。 |
|
| properties.privateEndpointConnections |
與指定 Redis Enterprise 叢集相關聯的私人端點連線清單 |
|
| properties.provisioningState |
叢集目前的佈建狀態 |
|
| properties.publicNetworkAccess |
公用網路流量是否可以存取Redis叢集。 只能設定「啟用」或「停用」。 null 只會針對使用舊 API 版本建立的叢集傳回,這些叢集沒有此內容且無法設定。 |
|
| properties.redisVersion |
string |
叢集支援的redis版本,例如'6' |
| properties.redundancyMode |
說明叢集目前的備援策略,這會影響預期的 SLA。 |
|
| properties.resourceState |
叢集的目前資源狀態 |
|
| sku |
要建立的 SKU 會影響價格、效能和功能。 |
|
| tags |
object |
資源標籤。 |
CmkIdentityType
此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型
| 值 | Description |
|---|---|
| systemAssignedIdentity | |
| userAssignedIdentity |
CustomerManagedKeyEncryption
資源的所有客戶自控金鑰加密屬性。 將此設定為空白物件,以使用Microsoft管理的金鑰加密。
| 名稱 | 類型 | Description |
|---|---|---|
| keyEncryptionKeyIdentity |
客戶管理的金鑰設定的所有身分識別組態,定義應用來驗證 Key Vault 的身分識別。 |
|
| keyEncryptionKeyUrl |
string |
金鑰加密金鑰 URL,僅限版本。 前任: |
Encryption
叢集的待用加密組態。
| 名稱 | 類型 | Description |
|---|---|---|
| customerManagedKeyEncryption |
資源的所有客戶自控金鑰加密屬性。 將此設定為空白物件,以使用Microsoft管理的金鑰加密。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
object |
其他資訊。 |
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳細數據。 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
| 名稱 | 類型 | Description |
|---|---|---|
| error |
error 物件。 |
HighAvailability
默認為啟用。 如果 highAvailability 已停用,則不會復寫數據集。 這會影響可用性 SLA,並增加資料遺失的風險。
| 值 | Description |
|---|---|
| Enabled | |
| Disabled |
KeyEncryptionKeyIdentity
客戶管理的金鑰設定的所有身分識別組態,定義應用來驗證 Key Vault 的身分識別。
| 名稱 | 類型 | Description |
|---|---|---|
| identityType |
此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型 |
|
| userAssignedIdentityResourceId |
string |
使用者指派的身分識別可用來存取金鑰加密金鑰 URL。 例如:/subscriptions//resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。 |
Kind
區分叢集的類型。 唯讀。
| 值 | Description |
|---|---|
| v1 | |
| v2 |
ManagedServiceIdentity
受控服務識別(系統指派和/或使用者指派的身分識別)
| 名稱 | 類型 | Description |
|---|---|---|
| principalId |
string (uuid) |
系統指派身分識別的服務主體標識碼。 此屬性只會針對系統指派的身分識別提供。 |
| tenantId |
string (uuid) |
系統指派身分識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。 |
| type |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 |
|
| userAssignedIdentities |
<string,
User |
User-Assigned 身分識別 |
ManagedServiceIdentityType
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。
| 值 | Description |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned |
PrivateEndpoint
私人端點資源。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
私人端點的 ARM 識別碼 |
PrivateEndpointConnection
私人端點聯機資源。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
資源的名稱 |
| properties.privateEndpoint |
私人端點的資源。 |
|
| properties.privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
| properties.provisioningState |
私人端點聯機資源的布建狀態。 |
|
| type |
string |
資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProvisioningState
目前的布建狀態。
| 值 | Description |
|---|---|
| Succeeded | |
| Creating | |
| Deleting | |
| Failed |
PrivateEndpointServiceConnectionStatus
私人端點連線狀態。
| 值 | Description |
|---|---|
| Pending | |
| Approved | |
| Rejected |
PrivateLinkServiceConnectionState
服務取用者與提供者之間連線狀態的相關信息集合。
| 名稱 | 類型 | Description |
|---|---|---|
| actionsRequired |
string |
訊息,指出服務提供者上的變更是否需要取用者的任何更新。 |
| description |
string |
核准/拒絕連線的原因。 |
| status |
指出服務擁有者是否已核准/拒絕/移除連線。 |
ProvisioningState
目前的佈建狀態
| 值 | Description |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Creating | |
| Updating | |
| Deleting |
PublicNetworkAccess
公用網路流量是否可以存取Redis叢集。 只能設定「啟用」或「停用」。 null 只會針對使用舊 API 版本建立的叢集傳回,這些叢集沒有此內容且無法設定。
| 值 | Description |
|---|---|
| Enabled | |
| Disabled |
RedundancyMode
說明叢集目前的備援策略,這會影響預期的 SLA。
| 值 | Description |
|---|---|
| None |
沒有冗餘。 將會發生可用性遺失。 |
| LR |
具有高可用性的本地備援。 |
| ZR |
區域冗餘。 更高的可用性。 |
ResourceState
目前的資源狀態
| 值 | Description |
|---|---|
| Running | |
| Creating | |
| CreateFailed | |
| Updating | |
| UpdateFailed | |
| Deleting | |
| DeleteFailed | |
| Enabling | |
| EnableFailed | |
| Disabling | |
| DisableFailed | |
| Disabled | |
| Scaling | |
| ScalingFailed | |
| Moving |
Sku
SKU 參數提供給建立 Redis Enterprise 叢集作業。
| 名稱 | 類型 | Description |
|---|---|---|
| capacity |
integer (int32) |
此屬性僅與 Enterprise 和 EnterpriseFlash SKU 搭配使用。 決定叢集的大小。 企業 SKU 的有效值為 (2、4、6、...) 和 EnterpriseFlash SKU 的有效值為 (3、9、15...)。 |
| name |
要部署的 Redis 企業叢集層級。 可能的值:(『Balanced_B5』、『MemoryOptimized_M10』、『ComputeOptimized_X5』等等)。 如需 SKU 的詳細資訊,請參閱最新的定價檔。 請注意,未來可能會支援其他 SKU。 |
SkuName
要部署的 Redis 企業叢集層級。 可能的值:(『Balanced_B5』、『MemoryOptimized_M10』、『ComputeOptimized_X5』等等)。 如需 SKU 的詳細資訊,請參閱最新的定價檔。 請注意,未來可能會支援其他 SKU。
| 值 | Description |
|---|---|
| Enterprise_E1 | |
| Enterprise_E5 | |
| Enterprise_E10 | |
| Enterprise_E20 | |
| Enterprise_E50 | |
| Enterprise_E100 | |
| Enterprise_E200 | |
| Enterprise_E400 | |
| EnterpriseFlash_F300 | |
| EnterpriseFlash_F700 | |
| EnterpriseFlash_F1500 | |
| Balanced_B0 | |
| Balanced_B1 | |
| Balanced_B3 | |
| Balanced_B5 | |
| Balanced_B10 | |
| Balanced_B20 | |
| Balanced_B50 | |
| Balanced_B100 | |
| Balanced_B150 | |
| Balanced_B250 | |
| Balanced_B350 | |
| Balanced_B500 | |
| Balanced_B700 | |
| Balanced_B1000 | |
| MemoryOptimized_M10 | |
| MemoryOptimized_M20 | |
| MemoryOptimized_M50 | |
| MemoryOptimized_M100 | |
| MemoryOptimized_M150 | |
| MemoryOptimized_M250 | |
| MemoryOptimized_M350 | |
| MemoryOptimized_M500 | |
| MemoryOptimized_M700 | |
| MemoryOptimized_M1000 | |
| MemoryOptimized_M1500 | |
| MemoryOptimized_M2000 | |
| ComputeOptimized_X3 | |
| ComputeOptimized_X5 | |
| ComputeOptimized_X10 | |
| ComputeOptimized_X20 | |
| ComputeOptimized_X50 | |
| ComputeOptimized_X100 | |
| ComputeOptimized_X150 | |
| ComputeOptimized_X250 | |
| ComputeOptimized_X350 | |
| ComputeOptimized_X500 | |
| ComputeOptimized_X700 | |
| FlashOptimized_A250 | |
| FlashOptimized_A500 | |
| FlashOptimized_A700 | |
| FlashOptimized_A1000 | |
| FlashOptimized_A1500 | |
| FlashOptimized_A2000 | |
| FlashOptimized_A4500 |
TlsVersion
叢集支援的最低 TLS 版本,例如 『1.2』。 未來可以新增較新版本。 請注意,TLS 1.0 和 TLS 1.1 現在已完全過時,您無法使用它們。 只有為了與舊版 API 的一致性,才會提及它們。
| 值 | Description |
|---|---|
| 1.0 | |
| 1.1 | |
| 1.2 |
UserAssignedIdentity
使用者指派的身分識別屬性
| 名稱 | 類型 | Description |
|---|---|---|
| clientId |
string (uuid) |
指派之身分識別的用戶端標識碼。 |
| principalId |
string (uuid) |
指派之身分識別的主體標識碼。 |