Share via


Database Class

Definition

Describes a database on the Redis Enterprise cluster

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.DatabaseTypeConverter))]
public class Database : Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.IDatabase, Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20240901Preview.DatabaseTypeConverter))>]
type Database = class
    interface IDatabase
    interface IJsonSerializable
    interface IResourceAutoGenerated
    interface IValidates
Public Class Database
Implements IDatabase, IValidates
Inheritance
Database
Attributes
Implements

Constructors

Database()

Creates an new Database 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

Id

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

Module

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

Name

The name of the resource

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

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Database.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Database.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of Database into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to