Redis Enterprise - Update

Reference

Service:: Redis Cache

API Version:: 2025-04-01

Updates an existing Redis Enterprise cluster

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2025-04-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the resource.
properties.encryption	Encryption	Encryption-at-rest configuration for the cluster.
properties.highAvailability	HighAvailability	Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.
properties.minimumTlsVersion	TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.
sku	Sku	The SKU to create, which affects price, performance, and features.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	Cluster	The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.
202 Accepted		The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status. Headers Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Name

Type

Description

200 OK

Cluster

The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.

202 Accepted

The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.

Headers

Location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RedisEnterpriseUpdate

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2025-04-01

{
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 9
  },
  "properties": {
    "minimumTlsVersion": "1.2"
  },
  "tags": {
    "tag1": "value1"
  }
}

Sample response

Status code:: 200

{
  "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",
    "encryption": {}
  }
}

Status code:: 202

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...

Definitions

Name	Description
Cluster	Describes the Redis Enterprise cluster
ClusterUpdate	A partial update to the Redis Enterprise cluster
CmkIdentityType	Only userAssignedIdentity is supported in this API version; other types may be supported in the future
CustomerManagedKeyEncryption	All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
Encryption	Encryption-at-rest configuration for the cluster.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HighAvailability	Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.
KeyEncryptionKeyIdentity	All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
Kind	Distinguishes the kind of cluster. Read-only.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProvisioningState	Current provisioning status
RedundancyMode	Explains the current redundancy strategy of the cluster, which affects the expected SLA.
ResourceState	Current resource status
Sku	SKU parameters supplied to the create Redis Enterprise cluster operation.
SkuName	The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future.
TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.
UserAssignedIdentity	User assigned identity properties

Cluster

Object

Describes the Redis Enterprise cluster

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	The identity of the resource.
kind	Kind	Distinguishes the kind of cluster. Read-only.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.encryption	Encryption	Encryption-at-rest configuration for the cluster.
properties.highAvailability	HighAvailability	Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.
properties.hostName	string	DNS name of the cluster endpoint
properties.minimumTlsVersion	TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections associated with the specified Redis Enterprise cluster
properties.provisioningState	ProvisioningState	Current provisioning status of the cluster
properties.redisVersion	string	Version of redis the cluster supports, e.g. '6'
properties.redundancyMode	RedundancyMode	Explains the current redundancy strategy of the cluster, which affects the expected SLA.
properties.resourceState	ResourceState	Current resource status of the cluster
sku	Sku	The SKU to create, which affects price, performance, and features.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
zones	string[]	The Availability Zones where this cluster will be deployed.

ClusterUpdate

Object

A partial update to the Redis Enterprise cluster

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the resource.
properties.encryption	Encryption	Encryption-at-rest configuration for the cluster.
properties.highAvailability	HighAvailability	Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.
properties.hostName	string	DNS name of the cluster endpoint
properties.minimumTlsVersion	TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections associated with the specified Redis Enterprise cluster
properties.provisioningState	ProvisioningState	Current provisioning status of the cluster
properties.redisVersion	string	Version of redis the cluster supports, e.g. '6'
properties.redundancyMode	RedundancyMode	Explains the current redundancy strategy of the cluster, which affects the expected SLA.
properties.resourceState	ResourceState	Current resource status of the cluster
sku	Sku	The SKU to create, which affects price, performance, and features.
tags	object	Resource tags.

CmkIdentityType

Enumeration

Only userAssignedIdentity is supported in this API version; other types may be supported in the future

Value	Description
systemAssignedIdentity
userAssignedIdentity

CustomerManagedKeyEncryption

Object

All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

Name	Type	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl	string	Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Object

Encryption-at-rest configuration for the cluster.

Name	Type	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HighAvailability

Enumeration

Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.

Value	Description
Disabled
Enabled

KeyEncryptionKeyIdentity

Object

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Name	Type	Description
identityType	CmkIdentityType	Only userAssignedIdentity is supported in this API version; other types may be supported in the future
userAssignedIdentityResourceId	string	User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

Kind

Enumeration

Distinguishes the kind of cluster. Read-only.

Value	Description
v1
v2

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

The Private Endpoint resource.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint

PrivateEndpointConnection

Object

The Private Endpoint Connection resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.privateEndpoint	PrivateEndpoint	The resource of private end point.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Enumeration

Current provisioning status

Value	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RedundancyMode

Enumeration

Explains the current redundancy strategy of the cluster, which affects the expected SLA.

Value	Description
LR	Local redundancy with high availability.
None	No redundancy. Availability loss will occur.
ZR	Zone redundant. Higher availability.

ResourceState

Enumeration

Current resource status

Value	Description
CreateFailed
Creating
DeleteFailed
Deleting
DisableFailed
Disabled
Disabling
EnableFailed
Enabling
Moving
Running
Scaling
ScalingFailed
UpdateFailed
Updating

Sku

Object

SKU parameters supplied to the create Redis Enterprise cluster operation.

Name	Type	Description
capacity	integer (int32)	This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs.
name	SkuName	The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future.

SkuName

Enumeration

The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future.

Value	Description
Balanced_B0
Balanced_B1
Balanced_B10
Balanced_B100
Balanced_B1000
Balanced_B150
Balanced_B20
Balanced_B250
Balanced_B3
Balanced_B350
Balanced_B5
Balanced_B50
Balanced_B500
Balanced_B700
ComputeOptimized_X10
ComputeOptimized_X100
ComputeOptimized_X150
ComputeOptimized_X20
ComputeOptimized_X250
ComputeOptimized_X3
ComputeOptimized_X350
ComputeOptimized_X5
ComputeOptimized_X50
ComputeOptimized_X500
ComputeOptimized_X700
EnterpriseFlash_F1500
EnterpriseFlash_F300
EnterpriseFlash_F700
Enterprise_E1
Enterprise_E10
Enterprise_E100
Enterprise_E20
Enterprise_E200
Enterprise_E400
Enterprise_E5
Enterprise_E50
FlashOptimized_A1000
FlashOptimized_A1500
FlashOptimized_A2000
FlashOptimized_A250
FlashOptimized_A4500
FlashOptimized_A500
FlashOptimized_A700
MemoryOptimized_M10
MemoryOptimized_M100
MemoryOptimized_M1000
MemoryOptimized_M150
MemoryOptimized_M1500
MemoryOptimized_M20
MemoryOptimized_M2000
MemoryOptimized_M250
MemoryOptimized_M350
MemoryOptimized_M50
MemoryOptimized_M500
MemoryOptimized_M700

TlsVersion

Enumeration

The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.

Value	Description
1.0
1.1
1.2

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Share via

Redis Enterprise - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

RedisEnterpriseUpdate

Sample request

Sample response

Definitions

Cluster

ClusterUpdate

CmkIdentityType

CustomerManagedKeyEncryption

Encryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighAvailability

KeyEncryptionKeyIdentity

Kind

ManagedServiceIdentity

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

RedundancyMode

ResourceState

Sku

SkuName

TlsVersion

UserAssignedIdentity