Database interface

Package:

@azure/arm-redisenterprisecache

Describes a database on the Redis Enterprise cluster

Extends

ProxyResource

Properties

accessKeysAuthentication	This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Default is Disabled.
clientProtocol	Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy	Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.
deferUpgrade	Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
evictionPolicy	Redis eviction policy - default is VolatileLRU
geoReplication	Optional set of properties to configure geo replication for this database.
modules	Optional set of redis modules to enable in this database - modules can only be added at creation time.
notifyKeyspaceEvents	Specifies which keyspace events should trigger notifications. Default is an empty string, meaning this feature is disabled. When enabled, at least 'K' (keyspace events) or 'E' (keyevent events) must be present. For example, 'AKE' enables all standard events. See https://redis.io/docs/latest/develop/use/keyspace-notifications/ for the complete list of event types.
persistence	Persistence settings
port	TCP port of the database endpoint. Specified at create time. Defaults to an available port.
provisioningState	Current provisioning status of the database
redisVersion	Version of Redis the database is running on, e.g. '6.0'
resourceState	Current resource status of the database

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

accessKeysAuthentication

This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Default is Disabled.

accessKeysAuthentication?: string

Property Value

string

clientProtocol

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

clientProtocol?: string

Property Value

string

clusteringPolicy

Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.

clusteringPolicy?: string

Property Value

string

deferUpgrade

Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade

deferUpgrade?: string

Property Value

string

evictionPolicy

Redis eviction policy - default is VolatileLRU

evictionPolicy?: string

Property Value

string

geoReplication

Optional set of properties to configure geo replication for this database.

geoReplication?: DatabaseCommonPropertiesGeoReplication

Property Value

DatabaseCommonPropertiesGeoReplication

modules

Optional set of redis modules to enable in this database - modules can only be added at creation time.

modules?: Module[]

Property Value

Module[]

notifyKeyspaceEvents

Specifies which keyspace events should trigger notifications. Default is an empty string, meaning this feature is disabled. When enabled, at least 'K' (keyspace events) or 'E' (keyevent events) must be present. For example, 'AKE' enables all standard events. See https://redis.io/docs/latest/develop/use/keyspace-notifications/ for the complete list of event types.

notifyKeyspaceEvents?: string

Property Value

string

persistence

Persistence settings

persistence?: Persistence

Property Value

Persistence

port

TCP port of the database endpoint. Specified at create time. Defaults to an available port.

port?: number

Property Value

number

provisioningState

Current provisioning status of the database

provisioningState?: string

Property Value

string

redisVersion

Version of Redis the database is running on, e.g. '6.0'

redisVersion?: string

Property Value

string

resourceState

Current resource status of the database

resourceState?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type