Share via

RedisOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

RedisManagementClient's

<xref:redis> attribute.

Constructor

RedisOperations(*args, **kwargs)

Methods

begin_create

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

Deletes a Redis cache.
begin_export_data

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

Deletes all of the keys in a cache.
begin_import_data

Import data into Redis cache.
begin_update

Update an existing Redis cache.
check_name_availability

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

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).
list_by_resource_group

Lists all Redis caches in a resource group.
list_by_subscription

Gets all Redis caches in the specified subscription.
list_keys

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

Gets any upgrade notifications for a Redis cache.
regenerate_key

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

begin_create

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

begin_create(resource_group_name: str, name: str, parameters: _models.RedisCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RedisResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
parameters
Required
RedisCreateParameters or IO[bytes]

Parameters supplied to the Create Redis operation. Is either a RedisCreateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[RedisResource]

An instance of LROPoller that returns either RedisResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a Redis cache.

begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_export_data

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

begin_export_data(resource_group_name: str, name: str, parameters: _models.ExportRDBParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
parameters
Required
ExportRDBParameters or IO[bytes]

Parameters for Redis export operation. Is either a ExportRDBParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_flush_cache

Deletes all of the keys in a cache.

begin_flush_cache(resource_group_name: str, cache_name: str, **kwargs: Any) -> LROPoller[OperationStatusResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
cache_name
Required
str

The name of the Redis cache. Required.

Returns

Type Description
LROPoller[OperationStatusResult]

An instance of LROPoller that returns either OperationStatusResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_import_data

Import data into Redis cache.

begin_import_data(resource_group_name: str, name: str, parameters: _models.ImportRDBParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
parameters
Required
ImportRDBParameters or IO[bytes]

Parameters for Redis import operation. Is either a ImportRDBParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Update an existing Redis cache.

begin_update(resource_group_name: str, name: str, parameters: _models.RedisUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RedisResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
parameters
Required
RedisUpdateParameters or IO[bytes]

Parameters supplied to the Update Redis operation. Is either a RedisUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[RedisResource]

An instance of LROPoller that returns either RedisResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_name_availability

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

check_name_availability(parameters: _models.CheckNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name Description
parameters
Required
CheckNameAvailabilityParameters or IO[bytes]

Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'. Is either a CheckNameAvailabilityParameters type or a IO[bytes] type. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

force_reboot

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

force_reboot(resource_group_name: str, name: str, parameters: _models.RedisRebootParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RedisForceRebootResponse

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
parameters
Required
RedisRebootParameters or IO[bytes]

Specifies which Redis node(s) to reboot. Is either a RedisRebootParameters type or a IO[bytes] type. Required.

Returns

Type Description
RedisForceRebootResponse

RedisForceRebootResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a Redis cache (resource description).

get(resource_group_name: str, name: str, **kwargs: Any) -> RedisResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.

Returns

Type Description
RedisResource

RedisResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists all Redis caches in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[RedisResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Returns

Type Description
ItemPaged[RedisResource]

An iterator like instance of either RedisResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_subscription

Gets all Redis caches in the specified subscription.

list_by_subscription(**kwargs: Any) -> Iterable[RedisResource]

Returns

Type Description
ItemPaged[RedisResource]

An iterator like instance of either RedisResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_keys

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

list_keys(resource_group_name: str, name: str, **kwargs: Any) -> RedisAccessKeys

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.

Returns

Type Description
RedisAccessKeys

RedisAccessKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_upgrade_notifications

Gets any upgrade notifications for a Redis cache.

list_upgrade_notifications(resource_group_name: str, name: str, history: float, **kwargs: Any) -> Iterable[UpgradeNotification]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
history
Required
float

how many minutes in past to look for upgrade notifications. Required.

Returns

Type Description
ItemPaged[UpgradeNotification]

An iterator like instance of either UpgradeNotification or the result of cls(response)

Exceptions

Type Description
HttpResponseError

regenerate_key

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

regenerate_key(resource_group_name: str, name: str, parameters: _models.RedisRegenerateKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RedisAccessKeys

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
parameters
Required
RedisRegenerateKeyParameters or IO[bytes]

Specifies which key to regenerate. Is either a RedisRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns

Type Description
RedisAccessKeys

RedisAccessKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.redis.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv193\\Lib\\site-packages\\azure\\mgmt\\redis\\models\\__init__.py'>