Share via

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

Version of Redis the database is running on, e.g. '6.0' NOTE: This property will not be serialized. It can only be populated by the server.
resourceState

Current resource status of the database NOTE: This property will not be serialized. It can only be populated by the server.

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

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

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
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

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.

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

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

provisioningState?: string

Property Value

string

redisVersion

Version of Redis the database is running on, e.g. '6.0' NOTE: This property will not be serialized. It can only be populated by the server.

redisVersion?: string

Property Value

string

resourceState

Current resource status of the database NOTE: This property will not be serialized. It can only be populated by the server.

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

id?: string

Property Value

string

Inherited From ProxyResource.id

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 ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

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 ProxyResource.type