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
提供給 Create 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
提供給 Create 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 節點（s）。 此作業需要快取資源的寫入許可權。 可能會遺失數據。
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>