RedisCreateParameters.yml

### YamlMime:TSType
name: RedisCreateParameters
uid: '@azure/arm-rediscache.RedisCreateParameters'
package: '@azure/arm-rediscache'
summary: Parameters supplied to the Create Redis operation.
fullName: RedisCreateParameters
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: disableAccessKeyAuthentication
    uid: '@azure/arm-rediscache.RedisCreateParameters.disableAccessKeyAuthentication'
    package: '@azure/arm-rediscache'
    summary: >-
      Authentication to Redis through access keys is disabled when set as true.
      Default value is false.
    fullName: disableAccessKeyAuthentication
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'disableAccessKeyAuthentication?: boolean'
      return:
        description: ''
        type: boolean
  - name: enableNonSslPort
    uid: '@azure/arm-rediscache.RedisCreateParameters.enableNonSslPort'
    package: '@azure/arm-rediscache'
    summary: Specifies whether the non-ssl Redis server port (6379) is enabled.
    fullName: enableNonSslPort
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'enableNonSslPort?: boolean'
      return:
        description: ''
        type: boolean
  - name: identity
    uid: '@azure/arm-rediscache.RedisCreateParameters.identity'
    package: '@azure/arm-rediscache'
    summary: The identity of the resource.
    fullName: identity
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'identity?: ManagedServiceIdentity'
      return:
        description: ''
        type: <xref uid="@azure/arm-rediscache.ManagedServiceIdentity" />
  - name: location
    uid: '@azure/arm-rediscache.RedisCreateParameters.location'
    package: '@azure/arm-rediscache'
    summary: The geo-location where the resource lives
    fullName: location
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'location: string'
      return:
        description: ''
        type: string
  - name: minimumTlsVersion
    uid: '@azure/arm-rediscache.RedisCreateParameters.minimumTlsVersion'
    package: '@azure/arm-rediscache'
    summary: >-
      Optional: requires clients to use a specified TLS version (or higher) to
      connect (e,g, '1.0', '1.1', '1.2')
    fullName: minimumTlsVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'minimumTlsVersion?: string'
      return:
        description: ''
        type: string
  - name: publicNetworkAccess
    uid: '@azure/arm-rediscache.RedisCreateParameters.publicNetworkAccess'
    package: '@azure/arm-rediscache'
    summary: >-
      Whether or not public endpoint access is allowed for this cache.  Value is
      optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled',
      private endpoints are the exclusive access method. Default value is
      'Enabled'
    fullName: publicNetworkAccess
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'publicNetworkAccess?: string'
      return:
        description: ''
        type: string
  - name: redisConfiguration
    uid: '@azure/arm-rediscache.RedisCreateParameters.redisConfiguration'
    package: '@azure/arm-rediscache'
    summary: >-
      All Redis Settings. Few possible keys:
      rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,
      maxmemory-policy,notify-keyspace-events, aof-backup-enabled,
      aof-storage-connection-string-0, aof-storage-connection-string-1 etc.
    fullName: redisConfiguration
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'redisConfiguration?: RedisCommonPropertiesRedisConfiguration'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/arm-rediscache.RedisCommonPropertiesRedisConfiguration" />
  - name: redisVersion
    uid: '@azure/arm-rediscache.RedisCreateParameters.redisVersion'
    package: '@azure/arm-rediscache'
    summary: >-
      Redis version. This should be in the form 'major[.minor]' (only 'major' is
      required) or the value 'latest' which refers to the latest stable Redis
      version that is available. Supported versions: 4.0, 6.0 (latest). Default
      value is 'latest'.
    fullName: redisVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'redisVersion?: string'
      return:
        description: ''
        type: string
  - name: replicasPerMaster
    uid: '@azure/arm-rediscache.RedisCreateParameters.replicasPerMaster'
    package: '@azure/arm-rediscache'
    summary: The number of replicas to be created per primary.
    fullName: replicasPerMaster
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'replicasPerMaster?: number'
      return:
        description: ''
        type: number
  - name: replicasPerPrimary
    uid: '@azure/arm-rediscache.RedisCreateParameters.replicasPerPrimary'
    package: '@azure/arm-rediscache'
    summary: The number of replicas to be created per primary.
    fullName: replicasPerPrimary
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'replicasPerPrimary?: number'
      return:
        description: ''
        type: number
  - name: shardCount
    uid: '@azure/arm-rediscache.RedisCreateParameters.shardCount'
    package: '@azure/arm-rediscache'
    summary: The number of shards to be created on a Premium Cluster Cache.
    fullName: shardCount
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'shardCount?: number'
      return:
        description: ''
        type: number
  - name: sku
    uid: '@azure/arm-rediscache.RedisCreateParameters.sku'
    package: '@azure/arm-rediscache'
    summary: The SKU of the Redis cache to deploy.
    fullName: sku
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'sku: Sku'
      return:
        description: ''
        type: <xref uid="@azure/arm-rediscache.Sku" />
  - name: staticIP
    uid: '@azure/arm-rediscache.RedisCreateParameters.staticIP'
    package: '@azure/arm-rediscache'
    summary: >-
      Static IP address. Optionally, may be specified when deploying a Redis
      cache inside an existing Azure Virtual Network; auto assigned by default.
    fullName: staticIP
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'staticIP?: string'
      return:
        description: ''
        type: string
  - name: subnetId
    uid: '@azure/arm-rediscache.RedisCreateParameters.subnetId'
    package: '@azure/arm-rediscache'
    summary: >-
      The full resource ID of a subnet in a virtual network to deploy the Redis
      cache in. Example format:
      /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
    fullName: subnetId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'subnetId?: string'
      return:
        description: ''
        type: string
  - name: tags
    uid: '@azure/arm-rediscache.RedisCreateParameters.tags'
    package: '@azure/arm-rediscache'
    summary: Resource tags.
    fullName: tags
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tags?: {[propertyName: string]: string}'
      return:
        description: ''
        type: '{[propertyName: string]: string}'
  - name: tenantSettings
    uid: '@azure/arm-rediscache.RedisCreateParameters.tenantSettings'
    package: '@azure/arm-rediscache'
    summary: A dictionary of tenant settings
    fullName: tenantSettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tenantSettings?: {[propertyName: string]: string}'
      return:
        description: ''
        type: '{[propertyName: string]: string}'
  - name: updateChannel
    uid: '@azure/arm-rediscache.RedisCreateParameters.updateChannel'
    package: '@azure/arm-rediscache'
    summary: >-
      Optional: Specifies the update channel for the monthly Redis updates your
      Redis Cache will receive. Caches using 'Preview' update channel get latest
      Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default
      value is 'Stable'.
    fullName: updateChannel
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'updateChannel?: string'
      return:
        description: ''
        type: string
  - name: zones
    uid: '@azure/arm-rediscache.RedisCreateParameters.zones'
    package: '@azure/arm-rediscache'
    summary: >-
      A list of availability zones denoting where the resource needs to come
      from.
    fullName: zones
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'zones?: string[]'
      return:
        description: ''
        type: string[]