Share via

ClusterCreateProperties interface

Package:
@azure/arm-redisenterprisecache

Properties of Redis Enterprise clusters for create operations

Extends
ClusterCommonProperties

Properties

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.

Inherited Properties

encryption

Encryption-at-rest configuration for the cluster.
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.
hostName

DNS name of the cluster endpoint NOTE: This property will not be serialized. It can only be populated by the server.
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.
privateEndpointConnections

List of private endpoint connections associated with the specified Redis Enterprise cluster NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Current provisioning status of the cluster NOTE: This property will not be serialized. It can only be populated by the server.
redisVersion

Version of redis the cluster supports, e.g. '6' NOTE: This property will not be serialized. It can only be populated by the server.
redundancyMode

Explains the current redundancy strategy of the cluster, which affects the expected SLA. NOTE: This property will not be serialized. It can only be populated by the server.
resourceState

Current resource status of the cluster NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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: null | string

Property Value

null | string

Inherited Property Details

encryption

Encryption-at-rest configuration for the cluster.

encryption?: ClusterCommonPropertiesEncryption

Property Value

ClusterCommonPropertiesEncryption

Inherited From ClusterCommonProperties.encryption

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?: string

Property Value

string

Inherited From ClusterCommonProperties.highAvailability

hostName

DNS name of the cluster endpoint NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

Inherited From ClusterCommonProperties.hostName

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?: string

Property Value

string

Inherited From ClusterCommonProperties.minimumTlsVersion

privateEndpointConnections

List of private endpoint connections associated with the specified Redis Enterprise cluster NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

Inherited From ClusterCommonProperties.privateEndpointConnections

provisioningState

Current provisioning status of the cluster NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From ClusterCommonProperties.provisioningState

redisVersion

Version of redis the cluster supports, e.g. '6' NOTE: This property will not be serialized. It can only be populated by the server.

redisVersion?: string

Property Value

string

Inherited From ClusterCommonProperties.redisVersion

redundancyMode

Explains the current redundancy strategy of the cluster, which affects the expected SLA. NOTE: This property will not be serialized. It can only be populated by the server.

redundancyMode?: string

Property Value

string

Inherited From ClusterCommonProperties.redundancyMode

resourceState

Current resource status of the cluster NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

Inherited From ClusterCommonProperties.resourceState