Databases interface

Package:

@azure/arm-redisenterprisecache

Interface representing a Databases.

Methods

beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)	Creates a database
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)	Creates a database
beginDelete(string, string, string, DatabasesDeleteOptionalParams)	Deletes a single database
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)	Deletes a single database
beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)	Exports a database file from target database.
beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)	Exports a database file from target database.
beginFlush(string, string, string, FlushParameters, DatabasesFlushOptionalParams)	Flushes all the keys in this database and also from its linked databases.
beginFlushAndWait(string, string, string, FlushParameters, DatabasesFlushOptionalParams)	Flushes all the keys in this database and also from its linked databases.
beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)	Forcibly removes the link to the specified database resource.
beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)	Forcibly removes the link to the specified database resource.
beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)	Imports database files to target database.
beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)	Imports database files to target database.
beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)	Regenerates the RedisEnterprise database's access keys.
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)	Regenerates the RedisEnterprise database's access keys.
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)	Updates a database
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)	Updates a database
get(string, string, string, DatabasesGetOptionalParams)	Gets information about a database in a RedisEnterprise cluster.
listByCluster(string, string, DatabasesListByClusterOptionalParams)	Gets all databases in the specified RedisEnterprise cluster.
listKeys(string, string, string, DatabasesListKeysOptionalParams)	Retrieves the access keys for the RedisEnterprise database.

Method Details

beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)

Creates a database

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

Database

Parameters supplied to the create or update database operation.

options

DatabasesCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>

beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)

Creates a database

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

Database

Parameters supplied to the create or update database operation.

options

DatabasesCreateOptionalParams

The options parameters.

Returns

Promise<Database>

beginDelete(string, string, string, DatabasesDeleteOptionalParams)

Deletes a single database

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

options

DatabasesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)

Deletes a single database

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

options

DatabasesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)

Exports a database file from target database.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

ExportClusterParameters

Storage information for exporting into the cluster

options

DatabasesExportOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)

Exports a database file from target database.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

ExportClusterParameters

Storage information for exporting into the cluster

options

DatabasesExportOptionalParams

The options parameters.

Returns

Promise<void>

beginFlush(string, string, string, FlushParameters, DatabasesFlushOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

FlushParameters

Information identifying the databases to be flushed

options

DatabasesFlushOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginFlushAndWait(string, string, string, FlushParameters, DatabasesFlushOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

FlushParameters

Information identifying the databases to be flushed

options

DatabasesFlushOptionalParams

The options parameters.

Returns

Promise<void>

beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)

Forcibly removes the link to the specified database resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

ForceUnlinkParameters

Information identifying the database to be unlinked.

options

DatabasesForceUnlinkOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)

Forcibly removes the link to the specified database resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

ForceUnlinkParameters

Information identifying the database to be unlinked.

options

DatabasesForceUnlinkOptionalParams

The options parameters.

Returns

Promise<void>

beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)

Imports database files to target database.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

ImportClusterParameters

Storage information for importing into the cluster

options

DatabasesImportOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)

Imports database files to target database.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

ImportClusterParameters

Storage information for importing into the cluster

options

DatabasesImportOptionalParams

The options parameters.

Returns

Promise<void>

beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)

Regenerates the RedisEnterprise database's access keys.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

RegenerateKeyParameters

Specifies which key to regenerate.

options

DatabasesRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>

beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)

Regenerates the RedisEnterprise database's access keys.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

RegenerateKeyParameters

Specifies which key to regenerate.

options

DatabasesRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)

Updates a database

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

DatabaseUpdate

Parameters supplied to the create or update database operation.

options

DatabasesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>

beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)

Updates a database

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

parameters

DatabaseUpdate

Parameters supplied to the create or update database operation.

options

DatabasesUpdateOptionalParams

The options parameters.

Returns

Promise<Database>

get(string, string, string, DatabasesGetOptionalParams)

Gets information about a database in a RedisEnterprise cluster.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

options

DatabasesGetOptionalParams

The options parameters.

Returns

Promise<Database>

listByCluster(string, string, DatabasesListByClusterOptionalParams)

Gets all databases in the specified RedisEnterprise cluster.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

options

DatabasesListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Database, Database[], PageSettings>

listKeys(string, string, string, DatabasesListKeysOptionalParams)

Retrieves the access keys for the RedisEnterprise database.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

databaseName

string

The name of the database.

options

DatabasesListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>