DatabaseProperties Class

Definition

Properties of Redis Enterprise databases, as opposed to general resource properties like location, tags

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.DatabasePropertiesTypeConverter))]
public class DatabaseProperties : Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.IDatabaseProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.DatabasePropertiesTypeConverter))>]
type DatabaseProperties = class
    interface IDatabaseProperties
    interface IJsonSerializable
Public Class DatabaseProperties
Implements IDatabaseProperties
Inheritance
DatabaseProperties
Attributes
Implements

Constructors

DatabaseProperties()

Creates an new DatabaseProperties instance.

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 must be chosen at create time, and cannot be changed 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

GeoReplicationGroupNickname

Name for the group of linked database resources

GeoReplicationLinkedDatabase

List of database resources to link with this database

Module

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

PersistenceAofEnabled

Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled.

PersistenceAofFrequency

Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact.

PersistenceRdbEnabled

Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled.

PersistenceRdbFrequency

Sets the frequency at which a snapshot of the database is created.

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DatabaseProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DatabaseProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.IDatabaseProperties.

FromJsonString(String)

Creates a new instance of DatabaseProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of DatabaseProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to