Database interface

Describes a database on the RedisEnterprise cluster

Extends

Properties

clientProtocol

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

clusteringPolicy

Clustering policy - default is OSSCluster. Specified at create time.

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.

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.

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

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. Specified at create time.

clusteringPolicy?: 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?: DatabasePropertiesGeoReplication

Property Value

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

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

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

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