Databases interface
表示数据库的接口。
方法
方法详细信息
beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)
创建数据库
function beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- Database
提供给创建或更新数据库作的参数。
- options
- DatabasesCreateOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)
创建数据库
function beginCreateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<Database>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- Database
提供给创建或更新数据库作的参数。
- options
- DatabasesCreateOptionalParams
选项参数。
返回
Promise<Database>
beginDelete(string, string, string, DatabasesDeleteOptionalParams)
删除单个数据库
function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- options
- DatabasesDeleteOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)
删除单个数据库
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- options
- DatabasesDeleteOptionalParams
选项参数。
返回
Promise<void>
beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
从目标数据库导出数据库文件。
function beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ExportClusterParameters
用于导出到群集的存储信息
- options
- DatabasesExportOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
从目标数据库导出数据库文件。
function beginExportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ExportClusterParameters
用于导出到群集的存储信息
- options
- DatabasesExportOptionalParams
选项参数。
返回
Promise<void>
beginFlush(string, string, string, DatabasesFlushOptionalParams)
刷新此数据库中的所有密钥,并从其链接的数据库刷新。
function beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- options
- DatabasesFlushOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFlushAndWait(string, string, string, DatabasesFlushOptionalParams)
刷新此数据库中的所有密钥,并从其链接的数据库刷新。
function beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- options
- DatabasesFlushOptionalParams
选项参数。
返回
Promise<void>
beginForceLinkToReplicationGroup(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
强行重新创建指定群集上的现有数据库,并将其重新加入到现有复制组。 重要说明: 此数据库中的所有数据将被丢弃,重新加入复制组时,该数据库将暂时不可用。
function beginForceLinkToReplicationGroup(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ForceLinkParameters
标识要取消链接的数据库的信息。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
beginForceLinkToReplicationGroupAndWait(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
强行重新创建指定群集上的现有数据库,并将其重新加入到现有复制组。 重要说明: 此数据库中的所有数据将被丢弃,重新加入复制组时,该数据库将暂时不可用。
function beginForceLinkToReplicationGroupAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<DatabasesForceLinkToReplicationGroupHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ForceLinkParameters
标识要取消链接的数据库的信息。
选项参数。
返回
beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
强行删除指向指定数据库资源的链接。
function beginForceUnlink(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ForceUnlinkParameters
标识要取消链接的数据库的信息。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
强行删除指向指定数据库资源的链接。
function beginForceUnlinkAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ForceUnlinkParameters
标识要取消链接的数据库的信息。
选项参数。
返回
Promise<void>
beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
将数据库文件导入目标数据库。
function beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ImportClusterParameters
用于导入群集的存储信息
- options
- DatabasesImportOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
将数据库文件导入目标数据库。
function beginImportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- ImportClusterParameters
用于导入群集的存储信息
- options
- DatabasesImportOptionalParams
选项参数。
返回
Promise<void>
beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
重新生成 Redis Enterprise 数据库的访问密钥。
function beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- RegenerateKeyParameters
指定要重新生成哪个密钥。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
重新生成 Redis Enterprise 数据库的访问密钥。
function beginRegenerateKeyAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<AccessKeys>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- RegenerateKeyParameters
指定要重新生成哪个密钥。
选项参数。
返回
Promise<AccessKeys>
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
更新数据库
function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- DatabaseUpdate
提供给创建或更新数据库作的参数。
- options
- DatabasesUpdateOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
更新数据库
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<Database>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- parameters
- DatabaseUpdate
提供给创建或更新数据库作的参数。
- options
- DatabasesUpdateOptionalParams
选项参数。
返回
Promise<Database>
beginUpgradeDBRedisVersion(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
将数据库 Redis 版本升级到最新的可用版本。
function beginUpgradeDBRedisVersion(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
beginUpgradeDBRedisVersionAndWait(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
将数据库 Redis 版本升级到最新的可用版本。
function beginUpgradeDBRedisVersionAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<DatabasesUpgradeDBRedisVersionHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
选项参数。
返回
get(string, string, string, DatabasesGetOptionalParams)
获取有关 Redis Enterprise 群集中的数据库的信息。
function get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- options
- DatabasesGetOptionalParams
选项参数。
返回
Promise<Database>
listByCluster(string, string, DatabasesListByClusterOptionalParams)
获取指定 Redis Enterprise 集群中的所有数据库。
function listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<Database, Database[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
选项参数。
返回
listKeys(string, string, string, DatabasesListKeysOptionalParams)
检索 Redis Enterprise 数据库的访问密钥。
function listKeys(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams): Promise<AccessKeys>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- clusterName
-
string
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符
- databaseName
-
string
Redis Enterprise 数据库的名称。
- options
- DatabasesListKeysOptionalParams
选项参数。
返回
Promise<AccessKeys>