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
identity	The managed service identities assigned to this resource.
kind	Distinguishes the kind of cluster. Read-only.
maintenanceConfiguration	Cluster-level maintenance configuration.
migratedEndpoint	The endpoint of the source resource that is currently pointing to this resource as a result of an ACR/ACRE to AMR migration.
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
provisioningState	Current provisioning status of the cluster
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'
redundancyMode	Explains the current redundancy strategy of the cluster, which affects the expected SLA.
resourceState	Current resource status of the cluster
sku	The SKU to create, which affects price, performance, and features.
zones	The availability zones.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

hostName?: string

Property Value

string

identity

The managed service identities assigned to this resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

kind

Distinguishes the kind of cluster. Read-only.

kind?: string

Property Value

string

maintenanceConfiguration

Cluster-level maintenance configuration.

maintenanceConfiguration?: MaintenanceConfiguration

Property Value

MaintenanceConfiguration

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

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Current provisioning status of the cluster

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'

redisVersion?: string

Property Value

string

redundancyMode

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

redundancyMode?: string

Property Value

string

resourceState

Current resource status of the cluster

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.

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}

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type