azure.mgmt.redisenterprise.operations module¶

class azure.mgmt.redisenterprise.operations.AccessPolicyAssignmentOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s access_policy_assignment attribute.

begin_create_update(resource_group_name: str, cluster_name: str, database_name: str, access_policy_assignment_name: str, parameters: _models.AccessPolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessPolicyAssignment][source]¶

begin_create_update(resource_group_name: str, cluster_name: str, database_name: str, access_policy_assignment_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessPolicyAssignment]

Creates/Updates a particular access policy assignment for a database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
access_policy_assignment_name (str) – The name of the Redis Enterprise database access policy assignment. Required.
parameters (AccessPolicyAssignment or IO[bytes]) – Parameters supplied to the create access policy assignment for database. Is either a AccessPolicyAssignment type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[AccessPolicyAssignment]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, cluster_name: str, database_name: str, access_policy_assignment_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes a single access policy assignment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
access_policy_assignment_name (str) – The name of the Redis Enterprise database access policy assignment. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, cluster_name: str, database_name: str, access_policy_assignment_name: str, **kwargs: Any) → AccessPolicyAssignment[source]¶

Gets information about access policy assignment for database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
access_policy_assignment_name (str) – The name of the Redis Enterprise database access policy assignment. Required.

Returns:

AccessPolicyAssignment or the result of cls(response)

Return type:

AccessPolicyAssignment

Raises:

HttpResponseError –

list(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) → Iterable[AccessPolicyAssignment][source]¶

Gets all access policy assignments..

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.

Returns:

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

Return type:

ItemPaged[AccessPolicyAssignment]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶

class azure.mgmt.redisenterprise.operations.DatabasesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s databases attribute.

begin_create(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.Database, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Database][source]¶

begin_create(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Database]

Creates a database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (Database or IO[bytes]) – Parameters supplied to the create or update database operation. Is either a Database type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Database]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes a single database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_export(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.ExportClusterParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None][source]¶

begin_export(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None]

Exports a database file from target database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (ExportClusterParameters or IO[bytes]) – Storage information for exporting into the cluster. Is either a ExportClusterParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_flush(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.FlushParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None][source]¶

begin_flush(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None]

Flushes all the keys in this database and also from its linked databases.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (FlushParameters or IO[bytes]) – Information identifying the databases to be flushed. Is either a FlushParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_force_link_to_replication_group(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.ForceLinkParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None][source]¶

begin_force_link_to_replication_group(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None]

Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (ForceLinkParameters or IO[bytes]) – Information identifying the database to be unlinked. Is either a ForceLinkParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_force_unlink(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.ForceUnlinkParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None][source]¶

begin_force_unlink(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None]

Forcibly removes the link to the specified database resource.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (ForceUnlinkParameters or IO[bytes]) – Information identifying the database to be unlinked. Is either a ForceUnlinkParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_import_method(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.ImportClusterParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None][source]¶

begin_import_method(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[None]

Imports database files to target database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (ImportClusterParameters or IO[bytes]) – Storage information for importing into the cluster. Is either a ImportClusterParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_regenerate_key(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.RegenerateKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessKeys][source]¶

begin_regenerate_key(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessKeys]

Regenerates the Redis Enterprise database’s access keys.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (RegenerateKeyParameters or IO[bytes]) – Specifies which key to regenerate. Is either a RegenerateKeyParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[AccessKeys]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, cluster_name: str, database_name: str, parameters: _models.DatabaseUpdate, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Database][source]¶

begin_update(resource_group_name: str, cluster_name: str, database_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Database]

Updates a database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.
parameters (DatabaseUpdate or IO[bytes]) – Parameters supplied to the create or update database operation. Is either a DatabaseUpdate type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Database]

Raises:

HttpResponseError –

begin_upgrade_db_redis_version(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) → LROPoller[None][source]¶

Upgrades the database Redis version to the latest available.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) → Database[source]¶

Gets information about a database in a Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.

Returns:

Database or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) → Iterable[Database][source]¶

Gets all databases in the specified Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.

Returns:

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

Return type:

ItemPaged[Database]

Raises:

HttpResponseError –

list_keys(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) → AccessKeys[source]¶

Retrieves the access keys for the Redis Enterprise database.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
database_name (str) – The name of the Redis Enterprise database. Required.

Returns:

AccessKeys or the result of cls(response)

Return type:

Raises:

HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶

class azure.mgmt.redisenterprise.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[Operation][source]¶

Lists all of the available REST API operations of the Microsoft.Cache provider.

Returns:: An iterator like instance of either Operation or the result of cls(response)
Return type:: ItemPaged[Operation]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶

class azure.mgmt.redisenterprise.operations.OperationsStatusOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s operations_status attribute.

get(location: str, operation_id: str, **kwargs: Any) → OperationStatus[source]¶

Gets the status of operation.

Parameters:

location (str) – The name of Azure region. Required.
operation_id (str) – The ID of an ongoing async operation. Required.

Returns:

OperationStatus or the result of cls(response)

Return type:

OperationStatus

Raises:

HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶

class azure.mgmt.redisenterprise.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s private_endpoint_connections attribute.

begin_delete(resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes the specified private endpoint connection associated with the Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_put(resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]¶

begin_put(resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, properties: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.
properties (PrivateEndpointConnection or IO[bytes]) – The private endpoint connection properties. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[PrivateEndpointConnection]

Raises:

HttpResponseError –

get(resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection[source]¶

Gets the specified private endpoint connection associated with the Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list(resource_group_name: str, cluster_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnection][source]¶

Lists all the private endpoint connections associated with the Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.

Returns:

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

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶

class azure.mgmt.redisenterprise.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s private_link_resources attribute.

list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) → Iterable[PrivateLinkResource][source]¶

Gets the private link resources that need to be created for a Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.

Returns:

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

Return type:

ItemPaged[PrivateLinkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶

class azure.mgmt.redisenterprise.operations.RedisEnterpriseOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RedisEnterpriseManagementClient’s redis_enterprise attribute.

begin_create(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster][source]¶

begin_create(resource_group_name: str, cluster_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster]

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
parameters (Cluster or IO[bytes]) – Parameters supplied to the Create Redis Enterprise operation. Is either a Cluster type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Cluster]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes a Redis Enterprise cache cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, cluster_name: str, parameters: _models.ClusterUpdate, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster][source]¶

begin_update(resource_group_name: str, cluster_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster]

Updates an existing Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.
parameters (ClusterUpdate or IO[bytes]) – Parameters supplied to the Update Redis Enterprise operation. Is either a ClusterUpdate type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Cluster]

Raises:

HttpResponseError –

get(resource_group_name: str, cluster_name: str, **kwargs: Any) → Cluster[source]¶

Gets information about a Redis Enterprise cluster.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Redis Enterprise cluster. Required.

Returns:

Cluster or the result of cls(response)

Return type:

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[Cluster][source]¶

Lists all Redis Enterprise clusters in the specified subscription.

Returns:: An iterator like instance of either Cluster or the result of cls(response)
Return type:: ItemPaged[Cluster]
Raises:: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Cluster][source]¶

Lists all Redis Enterprise clusters in a resource group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either Cluster or the result of cls(response)
Return type:: ItemPaged[Cluster]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.redisenterprise.models' from '/mnt/vss/_work/1/s/sdk/redisenterprise/azure-mgmt-redisenterprise/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/redisenterprise/models/__init__.py'>¶