Azure Redis Enterprise Management Client Library for Python

3.1.0 · active · verified Sun Apr 12

This is the Microsoft Azure Redis Enterprise Management Client Library for Python, providing tools to manage Azure Redis Enterprise resources. It currently supports Python 3.9+ and is part of the Azure SDK for Python, which follows a regular release cadence. The latest stable version, 3.1.0, was released in October 2025, following the General Availability of Azure Managed Redis in May 2025.

Warnings

breaking Operations that perform long-running actions (LROs) are now prefixed with `begin_` and return an `azure.core.polling.LROPoller` object instead of `msrest.polling.LROPoller`. For example, `PrivateEndpointConnectionsOperations.delete` was renamed to `PrivateEndpointConnectionsOperations.begin_delete` in version 2.1.0b2.
Fix: Update method calls to use the `begin_` prefix for LROs and adjust polling logic for `azure.core.polling.LROPoller`.
breaking The credential system was revamped across Azure SDKs. Old authentication methods (`azure.common.credentials` or `msrestazure.azure_active_directory`) are no longer supported. The `credentials` parameter has been renamed to `credential`.
Fix: Migrate to `azure-identity` classes (e.g., `DefaultAzureCredential`) for authentication and update client constructor to use the `credential` parameter.
gotcha There is a known issue where `client.databases.begin_update` may not correctly support PATCH operations for updating database persistence configurations, despite documentation suggesting so.
Fix: Verify desired updates via other means or consult Azure support if `begin_update` for database persistence fails unexpectedly. Consider creating a new database with updated settings and migrating data if a direct update is critical and not working.
deprecated Python 2.7 support for Azure SDK Python packages, including `azure-mgmt-redisenterprise`, ended on January 1, 2022.
Fix: Upgrade your Python environment to 3.9 or higher, as required by recent versions of this library.
gotcha Upcoming changes in Azure CLI (`az redisenterprise create` for May 2026) indicate future API versions may make certain parameters, like `--public-network-access`, required and change defaults (e.g., `--access-keys-auth` to 'Disabled'). While specific to CLI, this often reflects underlying API changes that could affect direct SDK usage.
Fix: Stay informed on Azure SDK release notes and Azure CLI breaking changes. Explicitly set values for parameters like `public_network_access` and `access_keys_auth` when creating/updating clusters to ensure consistent behavior across API versions.

Install

pip install azure-mgmt-redisenterprise azure-identity Install stable version

Imports

RedisEnterpriseManagementClient

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

DefaultAzureCredential

from azure.identity import DefaultAzureCredential

Sku
```
from azure.mgmt.redisenterprise.models import Sku
```
Commonly used model for cluster creation/update operations.
Database
```
from azure.mgmt.redisenterprise.models import Database
```
Commonly used model for database operations within a cluster.

Quickstart

Initializes the RedisEnterpriseManagementClient using DefaultAzureCredential for authentication and lists all Redis Enterprise clusters accessible within the configured Azure subscription. Ensure AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET environment variables are set for authentication.

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

# Set environment variables for authentication and subscription:
# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
# AZURE_SUBSCRIPTION_ID
# Learn more: https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication-overview

# Get subscription ID from environment variable
subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "")
if not subscription_id:
    raise ValueError("AZURE_SUBSCRIPTION_ID environment variable not set.")

# Authenticate with Azure
credential = DefaultAzureCredential()

# Create a Redis Enterprise Management client
client = RedisEnterpriseManagementClient(credential=credential, subscription_id=subscription_id)

# List all Redis Enterprise clusters in the subscription
print("Listing Redis Enterprise Clusters:")
for cluster in client.redis_enterprise.list():
    print(f"- Name: {cluster.name}, Location: {cluster.location}, SKU: {cluster.sku.name}")

view raw JSON →