RedisEnterpriseOperations Class

RedisEnterpriseOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

RedisEnterpriseOperations

Constructor

RedisEnterpriseOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.
begin_delete	Deletes a RedisEnterprise cache cluster.
begin_update	Updates an existing RedisEnterprise cluster.
get	Gets information about a RedisEnterprise cluster.
list	Gets all RedisEnterprise clusters in the specified subscription.
list_by_resource_group	Lists all RedisEnterprise clusters in a resource group.

begin_create

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.

begin_create(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.Cluster, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redisenterprise.models._models_py3.Cluster]

Parameters

resource_group_name

str

Required

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

cluster_name

str

Required

The name of the RedisEnterprise cluster.

parameters

Cluster

Required

Parameters supplied to the Create RedisEnterprise operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Cluster]

Exceptions

HttpResponseError

begin_delete

Deletes a RedisEnterprise cache cluster.

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

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

cluster_name

str

Required

The name of the RedisEnterprise cluster.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Updates an existing RedisEnterprise cluster.

begin_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.ClusterUpdate, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redisenterprise.models._models_py3.Cluster]

Parameters

resource_group_name

str

Required

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

cluster_name

str

Required

The name of the RedisEnterprise cluster.

parameters

ClusterUpdate

Required

Parameters supplied to the Update RedisEnterprise operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Cluster]

Exceptions

HttpResponseError

get

Gets information about a RedisEnterprise cluster.

get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.mgmt.redisenterprise.models._models_py3.Cluster

Parameters

resource_group_name

str

Required

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

cluster_name

str

Required

The name of the RedisEnterprise cluster.

cls

callable

A custom type or function that will be passed the direct response

Returns

Cluster, or the result of cls(response)

Return type

Cluster

Exceptions

HttpResponseError

list

Gets all RedisEnterprise clusters in the specified subscription.

list(**kwargs: Any) -> Iterable[azure.mgmt.redisenterprise.models._models_py3.ClusterList]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ClusterList]

Exceptions

HttpResponseError

list_by_resource_group

Lists all RedisEnterprise clusters in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.redisenterprise.models._models_py3.ClusterList]

Parameters

resource_group_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ClusterList]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.redisenterprise.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\redisenterprise\\models\\__init__.py'>