DatabaseUpdate interface
A partial update to the Redis Enterprise database
Properties
| access |
This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. |
| client |
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. |
| clustering |
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. |
| defer |
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade |
| eviction |
Redis eviction policy - default is VolatileLRU |
| geo |
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. |
| provisioning |
Current provisioning status of the database NOTE: This property will not be serialized. It can only be populated by the server. |
| redis |
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. |
| resource |
Current resource status of the database 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
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
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