你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Redis interface
表示 Redis 的接口。
方法
方法详细信息
beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)
创建或替换 (覆盖/重新创建，) 现有 Redis 缓存可能会停机。
function beginCreate(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- RedisCreateParameters
提供给创建 Redis 操作的参数。
- options
- RedisCreateOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)
创建或替换 (覆盖/重新创建，) 现有 Redis 缓存可能会停机。
function beginCreateAndWait(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<RedisResource>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- RedisCreateParameters
提供给创建 Redis 操作的参数。
- options
- RedisCreateOptionalParams
选项参数。
返回
Promise<RedisResource>
beginDelete(string, string, RedisDeleteOptionalParams)
删除 Redis 缓存。
function beginDelete(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- options
- RedisDeleteOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)
删除 Redis 缓存。
function beginDeleteAndWait(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- options
- RedisDeleteOptionalParams
选项参数。
返回
Promise<void>
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
将数据从 redis 缓存导出到容器中的 Blob。
function beginExportData(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- ExportRDBParameters
Redis 导出操作的参数。
- options
- RedisExportDataOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
将数据从 redis 缓存导出到容器中的 Blob。
function beginExportDataAndWait(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- ExportRDBParameters
Redis 导出操作的参数。
- options
- RedisExportDataOptionalParams
选项参数。
返回
Promise<void>
beginFlushCache(string, string, RedisFlushCacheOptionalParams)
删除缓存中的所有密钥。
function beginFlushCache(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- cacheName
-
string
Redis 缓存的名称。
- options
- RedisFlushCacheOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)
删除缓存中的所有密钥。
function beginFlushCacheAndWait(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<RedisFlushCacheResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- cacheName
-
string
Redis 缓存的名称。
- options
- RedisFlushCacheOptionalParams
选项参数。
返回
Promise<RedisFlushCacheResponse>
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
将数据导入 Redis 缓存。
function beginImportData(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- ImportRDBParameters
Redis 导入操作的参数。
- options
- RedisImportDataOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
将数据导入 Redis 缓存。
function beginImportDataAndWait(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- ImportRDBParameters
Redis 导入操作的参数。
- options
- RedisImportDataOptionalParams
选项参数。
返回
Promise<void>
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
更新现有的 Redis 缓存。
function beginUpdate(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- RedisUpdateParameters
提供给 Update Redis 操作的参数。
- options
- RedisUpdateOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
更新现有的 Redis 缓存。
function beginUpdateAndWait(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<RedisResource>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- RedisUpdateParameters
提供给 Update Redis 操作的参数。
- options
- RedisUpdateOptionalParams
选项参数。
返回
Promise<RedisResource>
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)
检查 redis 缓存名称是否有效且尚未使用。
function checkNameAvailability(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams): Promise<void>参数
- parameters
- CheckNameAvailabilityParameters
提供给 CheckNameAvailability Redis 操作的参数。 唯一支持的资源类型是“Microsoft.Cache/redis”
选项参数。
返回
Promise<void>
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)
重新启动指定的 Redis 节点 () 。 此操作需要缓存资源的写入权限。 可能会丢失数据。
function forceReboot(resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams): Promise<RedisForceRebootResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- RedisRebootParameters
指定要重新启动) (Redis 节点。
- options
- RedisForceRebootOptionalParams
选项参数。
返回
Promise<RedisForceRebootResponse>
get(string, string, RedisGetOptionalParams)
获取 redis 缓存 (资源说明) 。
function get(resourceGroupName: string, name: string, options?: RedisGetOptionalParams): Promise<RedisResource>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- options
- RedisGetOptionalParams
选项参数。
返回
Promise<RedisResource>
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)
列出资源组中的所有 Redis 缓存。
function listByResourceGroup(resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
选项参数。
返回
listBySubscription(RedisListBySubscriptionOptionalParams)
获取指定订阅中的所有 Redis 缓存。
function listBySubscription(options?: RedisListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>参数
选项参数。
返回
listKeys(string, string, RedisListKeysOptionalParams)
检索 Redis 缓存的访问密钥。 此操作需要缓存资源的写入权限。
function listKeys(resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams): Promise<RedisAccessKeys>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- options
- RedisListKeysOptionalParams
选项参数。
返回
Promise<RedisAccessKeys>
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)
获取 Redis 缓存的任何升级通知。
function listUpgradeNotifications(resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams): PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- history
-
number
过去查找升级通知的分钟数
选项参数。
返回
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)
重新生成 Redis 缓存的访问密钥。 此操作需要缓存资源的写入权限。
function regenerateKey(resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams): Promise<RedisAccessKeys>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
Redis 缓存的名称。
- parameters
- RedisRegenerateKeyParameters
指定要重新生成哪个密钥。
- options
- RedisRegenerateKeyOptionalParams
选项参数。
返回
Promise<RedisAccessKeys>