ClusterUpdate interface
A partial update to the Redis Enterprise cluster
Properties
| encryption | Encryption-at-rest configuration for the cluster. |
| high |
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. |
| host |
DNS name of the cluster endpoint |
| identity | The managed service identities assigned to this resource. |
| maintenance |
Cluster-level maintenance configuration. |
| migrated |
The endpoint of the source resource that is currently pointing to this resource as a result of an ACR/ACRE to AMR migration. |
| minimum |
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. |
| private |
List of private endpoint connections associated with the specified Redis Enterprise cluster |
| provisioning |
Current provisioning status of the cluster |
| public |
Whether or not public network traffic can access the Redis cluster. Only 'Enabled' or 'Disabled' can be set. null is returned only for clusters created using an old API version which do not have this property and cannot be set. |
| redis |
Version of redis the cluster supports, e.g. '6' |
| redundancy |
Explains the current redundancy strategy of the cluster, which affects the expected SLA. |
| resource |
Current resource status of the cluster |
| sku | The SKU to create, which affects price, performance, and features. |
| tags | Resource tags. |
Property Details
encryption
Encryption-at-rest configuration for the cluster.
encryption?: ClusterCommonPropertiesEncryptionProperty Value
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.
highAvailability?: stringProperty Value
string
hostName
DNS name of the cluster endpoint
hostName?: stringProperty Value
string
identity
The managed service identities assigned to this resource.
identity?: ManagedServiceIdentityProperty Value
maintenanceConfiguration
Cluster-level maintenance configuration.
maintenanceConfiguration?: MaintenanceConfigurationProperty Value
migratedEndpoint
The endpoint of the source resource that is currently pointing to this resource as a result of an ACR/ACRE to AMR migration.
migratedEndpoint?: stringProperty Value
string
minimumTlsVersion
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.
minimumTlsVersion?: stringProperty Value
string
privateEndpointConnections
List of private endpoint connections associated with the specified Redis Enterprise cluster
privateEndpointConnections?: PrivateEndpointConnection[]Property Value
provisioningState
Current provisioning status of the cluster
provisioningState?: stringProperty Value
string
publicNetworkAccess
Whether or not public network traffic can access the Redis cluster. Only 'Enabled' or 'Disabled' can be set. null is returned only for clusters created using an old API version which do not have this property and cannot be set.
publicNetworkAccess?: stringProperty Value
string
redisVersion
Version of redis the cluster supports, e.g. '6'
redisVersion?: stringProperty Value
string
redundancyMode
Explains the current redundancy strategy of the cluster, which affects the expected SLA.
redundancyMode?: stringProperty Value
string
resourceState
Current resource status of the cluster
resourceState?: stringProperty Value
string
sku
tags
Resource tags.
tags?: Record<string, string>Property Value
Record<string, string>
