Microsoft Azure SDK for Python

This is the Microsoft Azure Redis Enterprise Management Client Library. This package has been tested with Python 3.10+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

• Python 3.10+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-redisenterprise
pip install azure-identity

Authentication

By default, Microsoft Entra token authentication depends on correct configuration of the following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, client can be authenticated by following code:

from azure.identity import DefaultAzureCredential
from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = RedisEnterpriseManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

• Search Redis Enterprise Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

4.0.0 (2026-10-16)

Features Added

• Client RedisEnterpriseManagementClient added method send_request
• Client RedisEnterpriseManagementClient added operation group clusters
• Client RedisEnterpriseManagementClient added operation group migrations
• Model AccessPolicyAssignment added property properties
• Model AccessPolicyAssignment added property system_data
• Model Cluster added property properties
• Model Cluster added property system_data
• Model ClusterCreateProperties added property maintenance_configuration
• Model ClusterCreateProperties added property migrated_endpoint
• Model ClusterProperties added property maintenance_configuration
• Model ClusterProperties added property migrated_endpoint
• Model ClusterUpdate added property properties
• Model ClusterUpdateProperties added property maintenance_configuration
• Model ClusterUpdateProperties added property migrated_endpoint
• Model Database added property properties
• Model DatabaseCreateProperties added property notify_keyspace_events
• Model DatabaseProperties added property notify_keyspace_events
• Model DatabaseUpdateProperties added property notify_keyspace_events
• Model PrivateEndpointConnection added property properties
• Model PrivateEndpointConnection added property system_data
• Model PrivateLinkResource added property properties
• Model PrivateLinkResource added property system_data
• Model Resource added property system_data
• Model TrackedResource added property system_data
• Added model AccessPolicyAssignmentProperties
• Added model AzureCacheForRedisMigrationProperties
• Added model MaintenanceConfiguration
• Added enum MaintenanceDayOfWeek
• Added model MaintenanceWindow
• Added model MaintenanceWindowSchedule
• Added enum MaintenanceWindowType
• Added model Migration
• Added model MigrationProperties
• Added enum MigrationProvisioningState
• Added enum MigrationRollbackReason
• Added model MigrationUndoRequest
• Added model MigrationValidationDisparity
• Added model MigrationValidationError
• Added model MigrationValidationRequest
• Added model MigrationValidationResponse
• Added model MigrationValidationWarning
• Added model PrivateEndpointConnectionProperties
• Added model PrivateLinkResourceProperties
• Added enum SourceType
• Added operation group ClustersOperations
• Operation group ClustersOperations added method begin_unlink_migrated_endpoint
• Added operation group MigrationsOperations
• Operation group MigrationsOperations added method begin_undo
• Operation group MigrationsOperations added method begin_unlink_migrated_endpoint

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• Model Cluster moved instance variable high_availability, minimum_tls_version, encryption, host_name, provisioning_state, redundancy_mode, resource_state, redis_version, private_endpoint_connections and public_network_access under property properties whose type is ClusterCreateProperties
• Model ClusterUpdate moved instance variable high_availability, minimum_tls_version, encryption, host_name, provisioning_state, redundancy_mode, resource_state, redis_version, private_endpoint_connections and public_network_access under property properties whose type is ClusterUpdateProperties
• Model Database moved instance variable client_protocol, port, provisioning_state, resource_state, clustering_policy, eviction_policy, persistence, modules, geo_replication, redis_version, defer_upgrade and access_keys_authentication under property properties whose type is DatabaseCreateProperties
• Model DatabaseUpdate moved instance variable client_protocol, port, provisioning_state, resource_state, clustering_policy, eviction_policy, persistence, modules, geo_replication, redis_version, defer_upgrade and access_keys_authentication under property properties whose type is DatabaseUpdateProperties
• Model AccessPolicyAssignment moved instance variable access_policy_name, provisioning_state and user under property properties whose type is AccessPolicyAssignmentProperties
• Model PrivateEndpointConnection moved instance variable private_endpoint, private_link_service_connection_state and provisioning_state under property properties whose type is PrivateEndpointConnectionProperties
• Model PrivateLinkResource moved instance variable group_id, required_members and required_zone_names under property properties whose type is PrivateLinkResourceProperties

Other Changes

• Deleted model AccessPolicyAssignmentList/ClusterList/DatabaseList/ErrorDetailAutoGenerated/ErrorResponseAutoGenerated/OperationListResult/PrivateEndpointConnectionListResult/PrivateLinkResourceListResult/ProxyResourceAutoGenerated/ResourceAutoGenerated which actually were not used by SDK users

4.0.0b3 (2026-07-14)

Other Changes

• The two preceding preview releases (4.0.0b1 and 4.0.0b2) were published based on a preview API spec that contained a bug. The issue has been corrected in the 2026-06-01-preview API version used by this release. Please upgrade to 4.0.0b3 and do not use 4.0.0b1 or 4.0.0b2.

Features Added

• Model AccessPolicyAssignmentProperties added property access_string
• Model AccessPolicyAssignmentProperties added property provisioning_error
• Added model AccessPolicyAssignmentProvisioningError
• Operation group MigrationsOperations added method begin_cancel
• Operation group MigrationsOperations added method begin_start
• Operation group MigrationsOperations added method list

Breaking Changes

• Deleted or renamed client operation group RedisEnterpriseManagementClient.migration
• Deleted or renamed operation group MigrationOperations

4.0.0b2 (2026-06-12)

Features Added

• Model DatabaseCreateProperties added property notify_keyspace_events
• Model DatabaseProperties added property notify_keyspace_events
• Model DatabaseUpdateProperties added property notify_keyspace_events

4.0.0b1 (2026-03-26)

Features Added

• Client RedisEnterpriseManagementClient added method send_request
• Client RedisEnterpriseManagementClient added operation group migrations
• Client RedisEnterpriseManagementClient added operation group migration
• Model AccessPolicyAssignment added property system_data
• Model Cluster added property system_data
• Model ClusterCreateProperties added property maintenance_configuration
• Model ClusterCreateProperties added property migrated_endpoint
• Model ClusterProperties added property maintenance_configuration
• Model ClusterProperties added property migrated_endpoint
• Model ClusterUpdateProperties added property maintenance_configuration
• Model ClusterUpdateProperties added property migrated_endpoint
• Model PrivateEndpointConnection added property system_data
• Model PrivateLinkResource added property system_data
• Model Resource added property system_data
• Model TrackedResource added property system_data
• Added model AzureCacheForRedisMigrationProperties
• Added model MaintenanceConfiguration
• Added enum MaintenanceDayOfWeek
• Added model MaintenanceWindow
• Added model MaintenanceWindowSchedule
• Added enum MaintenanceWindowType
• Added model Migration
• Added model MigrationProperties
• Added enum MigrationProvisioningState
• Added model MigrationValidationDisparity
• Added model MigrationValidationError
• Added model MigrationValidationRequest
• Added model MigrationValidationResponse
• Added model MigrationValidationWarning
• Added enum SourceType
• Added operation group MigrationOperations
• Added operation group MigrationsOperations

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• Model Cluster moved instance variable high_availability, minimum_tls_version, encryption, host_name, provisioning_state, redundancy_mode, resource_state, redis_version, private_endpoint_connections and public_network_access under property properties
• Model ClusterUpdate moved instance variable high_availability, minimum_tls_version, encryption, host_name, provisioning_state, redundancy_mode, resource_state, redis_version, private_endpoint_connections and public_network_access under property properties
• Model Database moved instance variable client_protocol, port, provisioning_state, resource_state, clustering_policy, eviction_policy, persistence, modules, geo_replication, redis_version, defer_upgrade and access_keys_authentication under property properties
• Model DatabaseUpdate moved instance variable client_protocol, port, provisioning_state, resource_state, clustering_policy, eviction_policy, persistence, modules, geo_replication, redis_version, defer_upgrade and access_keys_authentication under property properties
• Deleted or renamed model ErrorDetailAutoGenerated
• Deleted or renamed model ErrorResponseAutoGenerated
• Deleted or renamed model ProxyResourceAutoGenerated
• Deleted or renamed model ResourceAutoGenerated

Other Changes

• Deleted model AccessPolicyAssignmentList/ClusterList/DatabaseList which actually were not used by SDK users

3.1.0 (2025-10-20)

Features Added

• Model RedisEnterpriseManagementClient added parameter cloud_setting in method __init__
• Client RedisEnterpriseManagementClient added operation group access_policy_assignment
• Model Cluster added property kind
• Model Cluster added property high_availability
• Model Cluster added property redundancy_mode
• Model Cluster added property public_network_access
• Model ClusterUpdate added property high_availability
• Model ClusterUpdate added property redundancy_mode
• Model ClusterUpdate added property public_network_access
• Enum ClusteringPolicy added member NO_CLUSTER
• Model Database added property redis_version
• Model Database added property defer_upgrade
• Model Database added property access_keys_authentication
• Model Database added property system_data
• Model DatabaseUpdate added property redis_version
• Model DatabaseUpdate added property defer_upgrade
• Model DatabaseUpdate added property access_keys_authentication
• Model ProxyResource added property system_data
• Enum ResourceState added member MOVING
• Enum SkuName added member BALANCED_B0
• Enum SkuName added member BALANCED_B1
• Enum SkuName added member BALANCED_B10
• Enum SkuName added member BALANCED_B100
• Enum SkuName added member BALANCED_B1000
• Enum SkuName added member BALANCED_B150
• Enum SkuName added member BALANCED_B20
• Enum SkuName added member BALANCED_B250
• Enum SkuName added member BALANCED_B3
• Enum SkuName added member BALANCED_B350
• Enum SkuName added member BALANCED_B5
• Enum SkuName added member BALANCED_B50
• Enum SkuName added member BALANCED_B500
• Enum SkuName added member BALANCED_B700
• Enum SkuName added member COMPUTE_OPTIMIZED_X10
• Enum SkuName added member COMPUTE_OPTIMIZED_X100
• Enum SkuName added member COMPUTE_OPTIMIZED_X150
• Enum SkuName added member COMPUTE_OPTIMIZED_X20
• Enum SkuName added member COMPUTE_OPTIMIZED_X250
• Enum SkuName added member COMPUTE_OPTIMIZED_X3
• Enum SkuName added member COMPUTE_OPTIMIZED_X350
• Enum SkuName added member COMPUTE_OPTIMIZED_X5
• Enum SkuName added member COMPUTE_OPTIMIZED_X50
• Enum SkuName added member COMPUTE_OPTIMIZED_X500
• Enum SkuName added member COMPUTE_OPTIMIZED_X700
• Enum SkuName added member ENTERPRISE_E1
• Enum SkuName added member ENTERPRISE_E200
• Enum SkuName added member ENTERPRISE_E400
• Enum SkuName added member ENTERPRISE_E5
• Enum SkuName added member FLASH_OPTIMIZED_A1000
• Enum SkuName added member FLASH_OPTIMIZED_A1500
• Enum SkuName added member FLASH_OPTIMIZED_A2000
• Enum SkuName added member FLASH_OPTIMIZED_A250
• Enum SkuName added member FLASH_OPTIMIZED_A4500
• Enum SkuName added member FLASH_OPTIMIZED_A500
• Enum SkuName added member FLASH_OPTIMIZED_A700
• Enum SkuName added member MEMORY_OPTIMIZED_M10
• Enum SkuName added member MEMORY_OPTIMIZED_M100
• Enum SkuName added member MEMORY_OPTIMIZED_M1000
• Enum SkuName added member MEMORY_OPTIMIZED_M150
• Enum SkuName added member MEMORY_OPTIMIZED_M1500
• Enum SkuName added member MEMORY_OPTIMIZED_M20
• Enum SkuName added member MEMORY_OPTIMIZED_M2000
• Enum SkuName added member MEMORY_OPTIMIZED_M250
• Enum SkuName added member MEMORY_OPTIMIZED_M350
• Enum SkuName added member MEMORY_OPTIMIZED_M50
• Enum SkuName added member MEMORY_OPTIMIZED_M500
• Enum SkuName added member MEMORY_OPTIMIZED_M700
• Added enum AccessKeysAuthentication
• Added model AccessPolicyAssignment
• Added model AccessPolicyAssignmentList
• Added model AccessPolicyAssignmentPropertiesUser
• Added model ClusterCreateProperties
• Added model ClusterProperties
• Added model ClusterUpdateProperties
• Added enum CreatedByType
• Added model DatabaseCreateProperties
• Added model DatabaseProperties
• Added model DatabaseUpdateProperties
• Added enum DeferUpgradeSetting
• Added model ErrorDetailAutoGenerated
• Added model ErrorResponseAutoGenerated
• Added model ForceLinkParameters
• Added model ForceLinkParametersGeoReplication
• Added enum HighAvailability
• Added enum Kind
• Added model ProxyResourceAutoGenerated
• Added enum PublicNetworkAccess
• Added enum RedundancyMode
• Added model ResourceAutoGenerated
• Added model SkuDetails
• Added model SkuDetailsList
• Added model SystemData
• Operation group DatabasesOperations added method begin_force_link_to_replication_group
• Operation group DatabasesOperations added method begin_upgrade_db_redis_version
• Operation group RedisEnterpriseOperations added method list_skus_for_scaling
• Added operation group AccessPolicyAssignmentOperations

3.1.0b4 (2025-04-23)

Breaking Changes

• Model SkuDetails renamed its instance variable customer_facing_size_in_gb to size_in_gb

3.1.0b3 (2025-04-20)

Features Added

• Model Cluster added property kind
• Enum ClusteringPolicy added member NO_CLUSTER
• Model ForceLinkParameters added property geo_replication
• Enum ResourceState added member MOVING
• Added model ErrorDetailAutoGenerated
• Added model ErrorResponseAutoGenerated
• Added model ForceLinkParametersGeoReplication
• Added enum Kind
• Added model SkuDetails
• Added model SkuDetailsList
• Operation group RedisEnterpriseOperations added method list_skus_for_scaling

Breaking Changes

• Model ForceLinkParameters deleted or renamed its instance variable group_nickname
• Model ForceLinkParameters deleted or renamed its instance variable linked_databases

3.1.0b2 (2024-10-16)

Features Added

• Added operation group AccessPolicyAssignmentOperations
• Model Cluster has a new parameter high_availability
• Model Cluster has a new parameter redundancy_mode
• Model ClusterUpdate has a new parameter high_availability
• Model ClusterUpdate has a new parameter redundancy_mode
• Model Database has a new parameter access_keys_authentication
• Model Database has a new parameter system_data
• Model DatabaseUpdate has a new parameter access_keys_authentication
• Model ProxyResource has a new parameter system_data

3.1.0b1 (2024-05-20)

Features Added

• Added operation DatabasesOperations.begin_force_link_to_replication_group
• Added operation DatabasesOperations.begin_upgrade_db_redis_version
• Model Database has a new parameter defer_upgrade
• Model Database has a new parameter redis_version
• Model DatabaseUpdate has a new parameter defer_upgrade
• Model DatabaseUpdate has a new parameter redis_version

3.0.0 (2024-03-04)

Features Added

• Added operation DatabasesOperations.begin_flush
• Model Cluster has a new parameter encryption
• Model Cluster has a new parameter identity
• Model ClusterUpdate has a new parameter encryption
• Model ClusterUpdate has a new parameter identity

Breaking Changes

• Renamed operation PrivateEndpointConnectionsOperations.delete to PrivateEndpointConnectionsOperations.begin_delete

2.1.0b2 (2023-04-20)

Features Added

• Added operation DatabasesOperations.begin_flush
• Added operation group SkusOperations
• Model Cluster has a new parameter encryption
• Model Cluster has a new parameter identity
• Model Cluster has a new parameter system_data
• Model ClusterUpdate has a new parameter encryption
• Model ClusterUpdate has a new parameter identity
• Model Database has a new parameter system_data
• Model PrivateEndpointConnection has a new parameter system_data
• Model PrivateLinkResource has a new parameter system_data
• Model ProxyResource has a new parameter system_data
• Model Resource has a new parameter system_data
• Model TrackedResource has a new parameter system_data

2.1.0b1 (2022-11-22)

Other Changes

• Added generated samples in github repo
• Drop support for python<3.7.0

2.0.0 (2022-04-04)

Features

• Added operation DatabasesOperations.begin_force_unlink
• Model Database has a new parameter geo_replication
• Model DatabaseUpdate has a new parameter geo_replication

Breaking changes

• Model ImportClusterParameters has a new required parameter sas_uris
• Model ImportClusterParameters no longer has parameter sas_uri

1.0.0 (2021-02-22)

Features

• Model Database has a new parameter persistence
• Model DatabaseUpdate has a new parameter persistence
• Added operation PrivateLinkResourcesOperations.list_by_cluster
• Added operation group OperationsStatusOperations

Breaking changes

• Removed operation PrivateLinkResourcesOperations.list_by_redis_enterprise_cache
• Removed operation group GetOperations

1.0.0b1 (2021-02-02)

• Initial Release