RedisOperations interface

Package:

@azure/arm-rediscache

Interface representing a Redis operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginExportData
beginExportDataAndWait
beginFlushCache
beginFlushCacheAndWait
beginImportData
beginImportDataAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks that the redis cache name is valid and is not already in use.
create	Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
delete	Deletes a Redis cache.
exportData	Export data from the redis cache to blobs in a container.
flushCache	Deletes all of the keys in a cache.
forceReboot	Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
get	Gets a Redis cache (resource description).
importData	Import data into Redis cache.
listByResourceGroup	Lists all Redis caches in a resource group.
listBySubscription	Gets all Redis caches in the specified subscription.
listKeys	Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
listUpgradeNotifications	[Deprecated] Gets any upgrade notifications for a Redis cache.
regenerateKey	Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
update	Update an existing Redis cache.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams) => Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>

Property Value

(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams) => Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams) => Promise<RedisResource>

Property Value

(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams) => Promise<RedisResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams) => Promise<void>

beginExportData

Warning

This API is now deprecated.

use exportData instead

beginExportData: (resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginExportDataAndWait

Warning

This API is now deprecated.

use exportData instead

beginExportDataAndWait: (resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams) => Promise<void>

beginFlushCache

Warning

This API is now deprecated.

use flushCache instead

beginFlushCache: (resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginFlushCacheAndWait

Warning

This API is now deprecated.

use flushCache instead

beginFlushCacheAndWait: (resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams) => Promise<OperationStatusResult>

beginImportData

Warning

This API is now deprecated.

use importData instead

beginImportData: (resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginImportDataAndWait

Warning

This API is now deprecated.

use importData instead

beginImportDataAndWait: (resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>

Property Value

(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams) => Promise<RedisResource>

Property Value

(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams) => Promise<RedisResource>

checkNameAvailability

Checks that the redis cache name is valid and is not already in use.

checkNameAvailability: (parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams) => Promise<void>

Property Value

(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams) => Promise<void>

create

Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.

create: (resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams) => PollerLike<OperationState<RedisResource>, RedisResource>

Property Value

(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams) => PollerLike<OperationState<RedisResource>, RedisResource>

delete

Deletes a Redis cache.

delete: (resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams) => PollerLike<OperationState<void>, void>

exportData

Export data from the redis cache to blobs in a container.

exportData: (resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams) => PollerLike<OperationState<void>, void>

flushCache

Deletes all of the keys in a cache.

flushCache: (resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

forceReboot

Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.

forceReboot: (resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams) => Promise<RedisForceRebootResponse>

Property Value

(resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams) => Promise<RedisForceRebootResponse>

get

Gets a Redis cache (resource description).

get: (resourceGroupName: string, name: string, options?: RedisGetOptionalParams) => Promise<RedisResource>

Property Value

(resourceGroupName: string, name: string, options?: RedisGetOptionalParams) => Promise<RedisResource>

importData

Import data into Redis cache.

importData: (resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams) => PollerLike<OperationState<void>, void>

listByResourceGroup

Lists all Redis caches in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

listBySubscription

Gets all Redis caches in the specified subscription.

listBySubscription: (options?: RedisListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

Property Value

(options?: RedisListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

listKeys

Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.

listKeys: (resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams) => Promise<RedisAccessKeys>

Property Value

(resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams) => Promise<RedisAccessKeys>

listUpgradeNotifications

[Deprecated] Gets any upgrade notifications for a Redis cache.

listUpgradeNotifications: (resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams) => PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>

Property Value

(resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams) => PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>

regenerateKey

Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.

regenerateKey: (resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams) => Promise<RedisAccessKeys>

Property Value

(resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams) => Promise<RedisAccessKeys>

update

Update an existing Redis cache.

update: (resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams) => PollerLike<OperationState<RedisResource>, RedisResource>

Property Value

(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams) => PollerLike<OperationState<RedisResource>, RedisResource>