ClusterProperties Class

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview
Assembly:
Az.RedisEnterpriseCache.private.dll

Properties of Redis Enterprise clusters, as opposed to general resource properties like location, tags

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.ClusterPropertiesTypeConverter))]
public class ClusterProperties : Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.IClusterProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.ClusterPropertiesTypeConverter))>]
type ClusterProperties = class
    interface IClusterProperties
    interface IJsonSerializable
Public Class ClusterProperties
Implements IClusterProperties
Inheritance
Object
ClusterProperties
Attributes
TypeConverterAttribute
Implements
IClusterProperties IJsonSerializable

Constructors

ClusterProperties()

Creates an new ClusterProperties instance.

Properties

CustomerManagedKeyEncryptionKeyUrl

Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
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
KeyEncryptionKeyIdentityType

Only userAssignedIdentity is supported in this API version; other types may be supported in the future
KeyEncryptionKeyIdentityUserAssignedIdentityResourceId
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.
PrivateEndpointConnection

List of private endpoint connections associated with the specified Redis Enterprise cluster
ProvisioningState

Current provisioning status of the cluster
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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ClusterProperties.
DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ClusterProperties.
FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.IClusterProperties.
FromJsonString(String)

Creates a new instance of ClusterProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)

Serializes this instance of ClusterProperties into a JsonNode.
ToJsonString()

Serializes this instance to a json string.

Applies to