Cluster Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview

Assembly:: Az.RedisEnterpriseCache.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describes the Redis Enterprise cluster

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.ClusterTypeConverter))]
public class Cluster : Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.ICluster, Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.ClusterTypeConverter))>]
type Cluster = class
    interface ICluster
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates

Public Class Cluster
Implements ICluster, IValidates

Inheritance: Object
Cluster

Attributes: TypeConverterAttribute

Implements: IResource ITrackedResource ICluster IJsonSerializable IValidates

Constructors

Cluster()

Creates an new Cluster instance.

Properties

CustomerManagedKeyEncryptionKeyUrl	Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
Database
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
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IdentityPrincipalId	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityTenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
IdentityUserAssignedIdentity	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
KeyEncryptionKeyIdentityType	Only userAssignedIdentity is supported in this API version; other types may be supported in the future
KeyEncryptionKeyIdentityUserAssignedIdentityResourceId
Location	The geo-location where the resource lives
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.
Name	The name of the resource
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
SkuCapacity	This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs.
SkuName	The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future.
Tag	Resource tags.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Zone	The Availability Zones where this cluster will be deployed.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of Cluster.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Cluster.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.ICluster.
FromJsonString(String)	Creates a new instance of Cluster, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Cluster into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via