Share via

RedisProperties interface

  • Reference
Package:
@azure/arm-rediscache

Properties of the redis cache.

Extends
RedisCreateProperties

Properties

accessKeys

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache NOTE: This property will not be serialized. It can only be populated by the server.
hostName

Redis host name. NOTE: This property will not be serialized. It can only be populated by the server.
instances

List of the Redis instances associated with the cache NOTE: This property will not be serialized. It can only be populated by the server.
linkedServers

List of the linked servers associated with the cache NOTE: This property will not be serialized. It can only be populated by the server.
port

Redis non-SSL port. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections

List of private endpoint connection associated with the specified redis cache NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Redis instance provisioning status. NOTE: This property will not be serialized. It can only be populated by the server.
sslPort

Redis SSL port. NOTE: This property will not be serialized. It can only be populated by the server.

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

Property Details

accessKeys

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache NOTE: This property will not be serialized. It can only be populated by the server.

accessKeys?: RedisAccessKeys

Property Value

RedisAccessKeys

hostName

Redis host name. NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

instances

List of the Redis instances associated with the cache NOTE: This property will not be serialized. It can only be populated by the server.

instances?: RedisInstanceDetails[]

Property Value

RedisInstanceDetails[]

linkedServers

List of the linked servers associated with the cache NOTE: This property will not be serialized. It can only be populated by the server.

linkedServers?: RedisLinkedServer[]

Property Value

RedisLinkedServer[]

port

Redis non-SSL port. NOTE: This property will not be serialized. It can only be populated by the server.

port?: number

Property Value

number

privateEndpointConnections

List of private endpoint connection associated with the specified redis cache NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Redis instance provisioning status. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sslPort

Redis SSL port. NOTE: This property will not be serialized. It can only be populated by the server.

sslPort?: number

Property Value

number

Inherited Property Details

disableAccessKeyAuthentication

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

disableAccessKeyAuthentication?: boolean

Property Value

boolean

Inherited From RedisCreateProperties.disableAccessKeyAuthentication

enableNonSslPort

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

enableNonSslPort?: boolean

Property Value

boolean

Inherited From RedisCreateProperties.enableNonSslPort

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

Inherited From RedisCreateProperties.minimumTlsVersion

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

Inherited From RedisCreateProperties.publicNetworkAccess

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

Inherited From RedisCreateProperties.redisConfiguration

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

Inherited From RedisCreateProperties.redisVersion

replicasPerMaster

The number of replicas to be created per primary.

replicasPerMaster?: number

Property Value

number

Inherited From RedisCreateProperties.replicasPerMaster

replicasPerPrimary

The number of replicas to be created per primary.

replicasPerPrimary?: number

Property Value

number

Inherited From RedisCreateProperties.replicasPerPrimary

shardCount

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

shardCount?: number

Property Value

number

Inherited From RedisCreateProperties.shardCount

sku

The SKU of the Redis cache to deploy.

sku: Sku

Property Value

Sku

Inherited From RedisCreateProperties.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

Inherited From RedisCreateProperties.staticIP

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

Inherited From RedisCreateProperties.subnetId

tenantSettings

A dictionary of tenant settings

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

Property Value

{[propertyName: string]: string}

Inherited From RedisCreateProperties.tenantSettings

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

Inherited From RedisCreateProperties.updateChannel