Share via

Cluster interface

Package:
@azure/arm-redisenterprisecache

Describes the Redis Enterprise cluster

Extends
TrackedResource

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

The identity of the resource.
kind

Distinguishes the kind of cluster. Read-only. 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.
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.
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.
sku

The SKU to create, which affects price, performance, and features.
zones

The Availability Zones where this cluster will be deployed.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

encryption

Encryption-at-rest configuration for the cluster.

encryption?: ClusterCommonPropertiesEncryption

Property Value

ClusterCommonPropertiesEncryption

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

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

identity

The identity of the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

kind

Distinguishes the kind of cluster. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

kind?: string

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

Property Value

string

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[]

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

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

Property Value

string

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

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

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

sku

The SKU to create, which affects price, performance, and features.

sku: Sku

Property Value

Sku

zones

The Availability Zones where this cluster will be deployed.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type