Redis interface
Interface representing a Redis.
Methods
Method Details
beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)
Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
function beginCreate(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- RedisCreateParameters
Parameters supplied to the Create Redis operation.
- options
- RedisCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)
Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
function beginCreateAndWait(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<RedisResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- RedisCreateParameters
Parameters supplied to the Create Redis operation.
- options
- RedisCreateOptionalParams
The options parameters.
Returns
Promise<RedisResource>
beginDelete(string, string, RedisDeleteOptionalParams)
Deletes a Redis cache.
function beginDelete(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- options
- RedisDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)
Deletes a Redis cache.
function beginDeleteAndWait(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- options
- RedisDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Export data from the redis cache to blobs in a container.
function beginExportData(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- ExportRDBParameters
Parameters for Redis export operation.
- options
- RedisExportDataOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Export data from the redis cache to blobs in a container.
function beginExportDataAndWait(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- ExportRDBParameters
Parameters for Redis export operation.
- options
- RedisExportDataOptionalParams
The options parameters.
Returns
Promise<void>
beginFlushCache(string, string, RedisFlushCacheOptionalParams)
Deletes all of the keys in a cache.
function beginFlushCache(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cacheName
-
string
The name of the Redis cache.
- options
- RedisFlushCacheOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)
Deletes all of the keys in a cache.
function beginFlushCacheAndWait(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<RedisFlushCacheResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cacheName
-
string
The name of the Redis cache.
- options
- RedisFlushCacheOptionalParams
The options parameters.
Returns
Promise<RedisFlushCacheResponse>
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Import data into Redis cache.
function beginImportData(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- ImportRDBParameters
Parameters for Redis import operation.
- options
- RedisImportDataOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Import data into Redis cache.
function beginImportDataAndWait(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- ImportRDBParameters
Parameters for Redis import operation.
- options
- RedisImportDataOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
Update an existing Redis cache.
function beginUpdate(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- RedisUpdateParameters
Parameters supplied to the Update Redis operation.
- options
- RedisUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
Update an existing Redis cache.
function beginUpdateAndWait(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<RedisResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- RedisUpdateParameters
Parameters supplied to the Update Redis operation.
- options
- RedisUpdateOptionalParams
The options parameters.
Returns
Promise<RedisResource>
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)
Checks that the redis cache name is valid and is not already in use.
function checkNameAvailability(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams): Promise<void>Parameters
- parameters
- CheckNameAvailabilityParameters
Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'
The options parameters.
Returns
Promise<void>
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)
Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
function forceReboot(resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams): Promise<RedisForceRebootResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- RedisRebootParameters
Specifies which Redis node(s) to reboot.
- options
- RedisForceRebootOptionalParams
The options parameters.
Returns
Promise<RedisForceRebootResponse>
get(string, string, RedisGetOptionalParams)
Gets a Redis cache (resource description).
function get(resourceGroupName: string, name: string, options?: RedisGetOptionalParams): Promise<RedisResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- options
- RedisGetOptionalParams
The options parameters.
Returns
Promise<RedisResource>
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)
Lists all Redis caches in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(RedisListBySubscriptionOptionalParams)
Gets all Redis caches in the specified subscription.
function listBySubscription(options?: RedisListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>Parameters
The options parameters.
Returns
listKeys(string, string, RedisListKeysOptionalParams)
Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
function listKeys(resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams): Promise<RedisAccessKeys>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- options
- RedisListKeysOptionalParams
The options parameters.
Returns
Promise<RedisAccessKeys>
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)
Gets any upgrade notifications for a Redis cache.
function listUpgradeNotifications(resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams): PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- history
-
number
how many minutes in past to look for upgrade notifications
The options parameters.
Returns
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)
Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
function regenerateKey(resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams): Promise<RedisAccessKeys>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- parameters
- RedisRegenerateKeyParameters
Specifies which key to regenerate.
- options
- RedisRegenerateKeyOptionalParams
The options parameters.
Returns
Promise<RedisAccessKeys>