Databases interface
Interface representing a Databases.
Methods
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- ExportClusterParameters
Storage information for exporting into the cluster
- options
- DatabasesExportOptionalParams
The options parameters.
Returns
Promise<void>
beginFlush(string, string, string, DatabasesFlushOptionalParams)
Flushes all the keys in this database and also from its linked databases.
function beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- options
- DatabasesFlushOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFlushAndWait(string, string, string, DatabasesFlushOptionalParams)
Flushes all the keys in this database and also from its linked databases.
function beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- options
- DatabasesFlushOptionalParams
The options parameters.
Returns
Promise<void>
beginForceLinkToReplicationGroup(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
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.
function beginForceLinkToReplicationGroup(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- ForceLinkParameters
Information identifying the database to be unlinked.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
beginForceLinkToReplicationGroupAndWait(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
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.
function beginForceLinkToReplicationGroupAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<DatabasesForceLinkToReplicationGroupHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- ForceLinkParameters
Information identifying the database to be unlinked.
The options parameters.
Returns
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- ForceUnlinkParameters
Information identifying the database to be unlinked.
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- ForceUnlinkParameters
Information identifying the database to be unlinked.
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- RegenerateKeyParameters
Specifies which key to regenerate.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
Regenerates the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- RegenerateKeyParameters
Specifies which key to regenerate.
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- parameters
- DatabaseUpdate
Parameters supplied to the create or update database operation.
- options
- DatabasesUpdateOptionalParams
The options parameters.
Returns
Promise<Database>
beginUpgradeDBRedisVersion(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
Upgrades the database Redis version to the latest available.
function beginUpgradeDBRedisVersion(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
beginUpgradeDBRedisVersionAndWait(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
Upgrades the database Redis version to the latest available.
function beginUpgradeDBRedisVersionAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<DatabasesUpgradeDBRedisVersionHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
The options parameters.
Returns
get(string, string, string, DatabasesGetOptionalParams)
Gets information about a database in a Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- options
- DatabasesGetOptionalParams
The options parameters.
Returns
Promise<Database>
listByCluster(string, string, DatabasesListByClusterOptionalParams)
Gets all databases in the specified Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
The options parameters.
Returns
listKeys(string, string, string, DatabasesListKeysOptionalParams)
Retrieves the access keys for the Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- databaseName
-
string
The name of the Redis Enterprise database.
- options
- DatabasesListKeysOptionalParams
The options parameters.
Returns
Promise<AccessKeys>