Share via

RedisResource interface

  • Reference
Package:
@azure/arm-rediscache

A single Redis item in List or Get Operation.

Extends
TrackedResource

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

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

The identity of the resource.
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.
minimumTlsVersion

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
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.
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.
sslPort

Redis SSL port. NOTE: This property will not be serialized. It can only be populated by the server.
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'.
zones

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

Inherited Properties

id

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

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

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.

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

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

hostName

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

hostName?: string

Property Value

string

identity

The identity of the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

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[]

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

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

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

sslPort

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

sslPort?: number

Property Value

number

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

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[]

Inherited Property Details

id

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.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

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.

type?: string

Property Value

string

Inherited From TrackedResource.type