Cluster.yml

### YamlMime:TSType
name: Cluster
uid: '@azure/arm-redisenterprisecache.Cluster'
package: '@azure/arm-redisenterprisecache'
summary: Describes the RedisEnterprise cluster
fullName: Cluster
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: encryption
    uid: '@azure/arm-redisenterprisecache.Cluster.encryption'
    package: '@azure/arm-redisenterprisecache'
    summary: Encryption-at-rest configuration for the cluster.
    fullName: encryption
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'encryption?: ClusterPropertiesEncryption'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/arm-redisenterprisecache.ClusterPropertiesEncryption" />
  - name: hostName
    uid: '@azure/arm-redisenterprisecache.Cluster.hostName'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      DNS name of the cluster endpoint

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: hostName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'hostName?: string'
      return:
        description: ''
        type: string
  - name: identity
    uid: '@azure/arm-redisenterprisecache.Cluster.identity'
    package: '@azure/arm-redisenterprisecache'
    summary: The identity of the resource.
    fullName: identity
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'identity?: ManagedServiceIdentity'
      return:
        description: ''
        type: <xref uid="@azure/arm-redisenterprisecache.ManagedServiceIdentity" />
  - name: minimumTlsVersion
    uid: '@azure/arm-redisenterprisecache.Cluster.minimumTlsVersion'
    package: '@azure/arm-redisenterprisecache'
    summary: The minimum TLS version for the cluster to support, e.g. '1.2'
    fullName: minimumTlsVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'minimumTlsVersion?: string'
      return:
        description: ''
        type: string
  - name: privateEndpointConnections
    uid: '@azure/arm-redisenterprisecache.Cluster.privateEndpointConnections'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      List of private endpoint connections associated with the specified
      RedisEnterprise cluster

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: privateEndpointConnections
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'privateEndpointConnections?: PrivateEndpointConnection[]'
      return:
        description: ''
        type: >-
          <xref uid="@azure/arm-redisenterprisecache.PrivateEndpointConnection"
          />[]
  - name: provisioningState
    uid: '@azure/arm-redisenterprisecache.Cluster.provisioningState'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      Current provisioning status of the cluster

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: provisioningState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provisioningState?: string'
      return:
        description: ''
        type: string
  - name: redisVersion
    uid: '@azure/arm-redisenterprisecache.Cluster.redisVersion'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      Version of redis the cluster supports, e.g. '6'

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: redisVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'redisVersion?: string'
      return:
        description: ''
        type: string
  - name: resourceState
    uid: '@azure/arm-redisenterprisecache.Cluster.resourceState'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      Current resource status of the cluster

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: resourceState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'resourceState?: string'
      return:
        description: ''
        type: string
  - name: sku
    uid: '@azure/arm-redisenterprisecache.Cluster.sku'
    package: '@azure/arm-redisenterprisecache'
    summary: The SKU to create, which affects price, performance, and features.
    fullName: sku
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'sku: Sku'
      return:
        description: ''
        type: <xref uid="@azure/arm-redisenterprisecache.Sku" />
  - name: zones
    uid: '@azure/arm-redisenterprisecache.Cluster.zones'
    package: '@azure/arm-redisenterprisecache'
    summary: The Availability Zones where this cluster will be deployed.
    fullName: zones
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'zones?: string[]'
      return:
        description: ''
        type: string[]
inheritedProperties:
  - name: id
    uid: '@azure/arm-redisenterprisecache.Cluster.id'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      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.
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [TrackedResource.id](xref:@azure/arm-redisenterprisecache.TrackedResource.id)
  - name: location
    uid: '@azure/arm-redisenterprisecache.Cluster.location'
    package: '@azure/arm-redisenterprisecache'
    summary: The geo-location where the resource lives
    fullName: location
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'location: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [TrackedResource.location](xref:@azure/arm-redisenterprisecache.TrackedResource.location)
  - name: name
    uid: '@azure/arm-redisenterprisecache.Cluster.name'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      The name of the resource

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [TrackedResource.name](xref:@azure/arm-redisenterprisecache.TrackedResource.name)
  - name: tags
    uid: '@azure/arm-redisenterprisecache.Cluster.tags'
    package: '@azure/arm-redisenterprisecache'
    summary: Resource tags.
    fullName: tags
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tags?: {[propertyName: string]: string}'
      return:
        description: ''
        type: '{[propertyName: string]: string}'
    inheritanceDescription: >-
      <b>Inherited From</b>
      [TrackedResource.tags](xref:@azure/arm-redisenterprisecache.TrackedResource.tags)
  - name: type
    uid: '@azure/arm-redisenterprisecache.Cluster.type'
    package: '@azure/arm-redisenterprisecache'
    summary: >-
      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.
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [TrackedResource.type](xref:@azure/arm-redisenterprisecache.TrackedResource.type)
extends: <xref uid="@azure/arm-redisenterprisecache.TrackedResource" />