DatabasesOperations interface

Package:

@azure/arm-redisenterprisecache

Interface representing a Databases operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginExport
beginExportAndWait
beginFlush
beginFlushAndWait
beginForceLinkToReplicationGroup
beginForceLinkToReplicationGroupAndWait
beginForceUnlink
beginForceUnlinkAndWait
beginImport
beginImportAndWait
beginRegenerateKey
beginRegenerateKeyAndWait
beginUpdate
beginUpdateAndWait
beginUpgradeDBRedisVersion
beginUpgradeDBRedisVersionAndWait
create	Creates a database
delete	Deletes a single database
export	Exports a database file from target database.
flush	Flushes all the keys in this database and also from its linked databases.
forceLinkToReplicationGroup	Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.
forceUnlink	Forcibly removes the link to the specified database resource.
get	Gets information about a database in a Redis Enterprise cluster.
import	Imports database files to target database.
listByCluster	Gets all databases in the specified Redis Enterprise cluster.
listKeys	Retrieves the access keys for the Redis Enterprise database.
regenerateKey	Regenerates the Redis Enterprise database's access keys.
update	Updates a database
upgradeDBRedisVersion	Upgrades the database Redis version to the latest available.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams) => Promise<Database>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<void>

beginExport

Warning

This API is now deprecated.

use export instead

beginExport: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginExportAndWait

Warning

This API is now deprecated.

use export instead

beginExportAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams) => Promise<void>

beginFlush

Warning

This API is now deprecated.

use flush instead

beginFlush: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFlushAndWait

Warning

This API is now deprecated.

use flush instead

beginFlushAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams) => Promise<void>

beginForceLinkToReplicationGroup

Warning

This API is now deprecated.

use forceLinkToReplicationGroup instead

beginForceLinkToReplicationGroup: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginForceLinkToReplicationGroupAndWait

Warning

This API is now deprecated.

use forceLinkToReplicationGroup instead

beginForceLinkToReplicationGroupAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams) => Promise<void>

beginForceUnlink

Warning

This API is now deprecated.

use forceUnlink instead

beginForceUnlink: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginForceUnlinkAndWait

Warning

This API is now deprecated.

use forceUnlink instead

beginForceUnlinkAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams) => Promise<void>

beginImport

Warning

This API is now deprecated.

use import instead

beginImport: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginImportAndWait

Warning

This API is now deprecated.

use import instead

beginImportAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams) => Promise<void>

beginRegenerateKey

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKey: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>

beginRegenerateKeyAndWait

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKeyAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams) => Promise<AccessKeys>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams) => Promise<AccessKeys>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<Database>

beginUpgradeDBRedisVersion

Warning

This API is now deprecated.

use upgradeDBRedisVersion instead

beginUpgradeDBRedisVersion: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginUpgradeDBRedisVersionAndWait

Warning

This API is now deprecated.

use upgradeDBRedisVersion instead

beginUpgradeDBRedisVersionAndWait: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams) => Promise<void>

create

Creates a database

create: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams) => PollerLike<OperationState<Database>, Database>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams) => PollerLike<OperationState<Database>, Database>

delete

Deletes a single database

delete: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

export

Exports a database file from target database.

export: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams) => PollerLike<OperationState<void>, void>

flush

Flushes all the keys in this database and also from its linked databases.

flush: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams) => PollerLike<OperationState<void>, void>

forceLinkToReplicationGroup

Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.

forceLinkToReplicationGroup: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams) => PollerLike<OperationState<void>, void>

forceUnlink

Forcibly removes the link to the specified database resource.

forceUnlink: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about a database in a Redis Enterprise cluster.

get: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams) => Promise<Database>

import

Imports database files to target database.

import: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams) => PollerLike<OperationState<void>, void>

listByCluster

Gets all databases in the specified Redis Enterprise cluster.

listByCluster: (resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

listKeys

Retrieves the access keys for the Redis Enterprise database.

listKeys: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams) => Promise<AccessKeys>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams) => Promise<AccessKeys>

regenerateKey

Regenerates the Redis Enterprise database's access keys.

regenerateKey: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams) => PollerLike<OperationState<AccessKeys>, AccessKeys>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams) => PollerLike<OperationState<AccessKeys>, AccessKeys>

update

Updates a database

update: (resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => PollerLike<OperationState<Database>, Database>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => PollerLike<OperationState<Database>, Database>

upgradeDBRedisVersion

Upgrades the database Redis version to the latest available.

upgradeDBRedisVersion: (resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams) => PollerLike<OperationState<void>, void>