RedisCreateParameters interface

Package:

@azure/arm-rediscache

Parameters supplied to the Create Redis operation.

Properties

disableAccessKeyAuthentication	Authentication to Redis through access keys is disabled when set as true. Default value is false.
enableNonSslPort	Specifies whether the non-ssl Redis server port (6379) is enabled.
identity	The identity of the resource.
location	The geo-location where the resource lives
minimumTlsVersion	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
publicNetworkAccess	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'
redisConfiguration	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.
redisVersion	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'.
replicasPerMaster	The number of replicas to be created per primary.
replicasPerPrimary	The number of replicas to be created per primary.
shardCount	The number of shards to be created on a Premium Cluster Cache.
sku	The SKU of the Redis cache to deploy.
staticIP	Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
subnetId	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
tags	Resource tags.
tenantSettings	A dictionary of tenant settings
updateChannel	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'.
zones	A list of availability zones denoting where the resource needs to come from.

Property Details

disableAccessKeyAuthentication

Authentication to Redis through access keys is disabled when set as true. Default value is false.

disableAccessKeyAuthentication?: boolean

Property Value

boolean

enableNonSslPort

Specifies whether the non-ssl Redis server port (6379) is enabled.

enableNonSslPort?: boolean

Property Value

boolean

identity

The identity of the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

location

The geo-location where the resource lives

location: string

Property Value

string

minimumTlsVersion

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')

minimumTlsVersion?: string

Property Value

string

publicNetworkAccess

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'

publicNetworkAccess?: string

Property Value

string

redisConfiguration

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.

redisConfiguration?: RedisCommonPropertiesRedisConfiguration

Property Value

RedisCommonPropertiesRedisConfiguration

redisVersion

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'.

redisVersion?: string

Property Value

string

replicasPerMaster

The number of replicas to be created per primary.

replicasPerMaster?: number

Property Value

number

replicasPerPrimary

The number of replicas to be created per primary.

replicasPerPrimary?: number

Property Value

number

shardCount

The number of shards to be created on a Premium Cluster Cache.

shardCount?: number

Property Value

number

sku

The SKU of the Redis cache to deploy.

sku: Sku

Property Value

Sku

staticIP

Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.

staticIP?: string

Property Value

string

subnetId

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

subnetId?: string

Property Value

string

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

tenantSettings

A dictionary of tenant settings

tenantSettings?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

updateChannel

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'.

updateChannel?: string

Property Value

string

zones

A list of availability zones denoting where the resource needs to come from.

zones?: string[]

Property Value

string[]