RedisCommonProperties interface
Create/Update/Get common properties of the redis cache.
Properties
| disable |
Authentication to Redis through access keys is disabled when set as true. Default value is false. |
| enable |
Specifies whether the non-ssl Redis server port (6379) is enabled. |
| minimum |
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') |
| public |
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' |
| redis |
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. |
| redis |
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'. |
| replicas |
The number of replicas to be created per primary. |
| replicas |
The number of replicas to be created per primary. |
| shard |
The number of shards to be created on a Premium Cluster Cache. |
| tenant |
A dictionary of tenant settings |
| update |
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
disableAccessKeyAuthentication
Authentication to Redis through access keys is disabled when set as true. Default value is false.
disableAccessKeyAuthentication?: booleanProperty Value
boolean
enableNonSslPort
Specifies whether the non-ssl Redis server port (6379) is enabled.
enableNonSslPort?: booleanProperty Value
boolean
minimumTlsVersion
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
minimumTlsVersion?: stringProperty 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?: stringProperty 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?: RedisCommonPropertiesRedisConfigurationProperty Value
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?: stringProperty Value
string
replicasPerMaster
The number of replicas to be created per primary.
replicasPerMaster?: numberProperty Value
number
replicasPerPrimary
The number of replicas to be created per primary.
replicasPerPrimary?: numberProperty Value
number
shardCount
The number of shards to be created on a Premium Cluster Cache.
shardCount?: numberProperty Value
number
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?: stringProperty Value
string