Cluster Class
Definition
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 RedisEnterprise cluster
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ClusterTypeConverter))]
public class Cluster : Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ICluster, Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Runtime.IValidates[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ClusterTypeConverter))>]
type Cluster = class
interface ICluster
interface IJsonSerializable
interface ITrackedResource
interface IResource
interface IValidatesPublic Class Cluster
Implements ICluster, IValidates- Inheritance
-
Cluster
- Attributes
- Implements
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 | |
| 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' |
| Name |
The name of the resource |
| PrivateEndpointConnection |
List of private endpoint connections associated with the specified RedisEnterprise cluster |
| ProvisioningState |
Current provisioning status of the cluster |
| RedisVersion |
Version of redis the cluster supports, e.g. '6' |
| ResourceState |
Current resource status of the cluster |
| SkuCapacity |
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. |
| SkuName |
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| SystemDataCreatedAt |
The timestamp of resource creation (UTC). |
| SystemDataCreatedBy |
The identity that created the resource. |
| SystemDataCreatedByType |
The type of identity that created the resource. |
| SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) |
| SystemDataLastModifiedBy |
The identity that last modified the resource. |
| SystemDataLastModifiedByType |
The type of identity that last modified the resource. |
| 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) | |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ICluster. |
| FromJsonString(String) |
Creates a new instance of Cluster, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) | |
| ToJsonString() |
Serializes this instance to a json string. |
| Validate(IEventListener) |
Validates that this object meets the validation criteria. |