Microsoft Azure SDK for Python

This is the Microsoft Azure Redis Cache Management Client Library. This package has been tested with Python 3.8+. 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.8+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-redis
pip install azure-identity

Authentication

By default, Azure Active Directory token authentication depends on correct configure of 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.redis import RedisManagementClient
import os

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

Examples

Code samples for this package can be found at:

• Search Redis Cache 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

14.5.0 (2025-01-20)

Features Added

• Model RedisCommonProperties added property zonal_allocation_policy
• Model RedisCreateParameters added property zonal_allocation_policy
• Model RedisCreateProperties added property zonal_allocation_policy
• Model RedisProperties added property zonal_allocation_policy
• Model RedisResource added property zonal_allocation_policy
• Model RedisUpdateParameters added property zonal_allocation_policy
• Model RedisUpdateProperties added property zonal_allocation_policy
• Added enum ZonalAllocationPolicy

14.4.0 (2024-07-21)

Features Added

• Model RedisCommonProperties has a new parameter disable_access_key_authentication
• Model RedisCommonPropertiesRedisConfiguration has a new parameter notify_keyspace_events
• Model RedisCreateParameters has a new parameter disable_access_key_authentication
• Model RedisCreateProperties has a new parameter disable_access_key_authentication
• Model RedisProperties has a new parameter disable_access_key_authentication
• Model RedisResource has a new parameter disable_access_key_authentication
• Model RedisUpdateParameters has a new parameter disable_access_key_authentication
• Model RedisUpdateProperties has a new parameter disable_access_key_authentication

14.3.0 (2023-09-19)

Features Added

• Added operation RedisOperations.begin_flush_cache
• Added operation group AccessPolicyAssignmentOperations
• Added operation group AccessPolicyOperations
• Model RedisCommonProperties has a new parameter update_channel
• Model RedisCommonPropertiesRedisConfiguration has a new parameter aad_enabled
• Model RedisCreateParameters has a new parameter update_channel
• Model RedisCreateProperties has a new parameter update_channel
• Model RedisProperties has a new parameter update_channel
• Model RedisResource has a new parameter update_channel
• Model RedisUpdateParameters has a new parameter update_channel
• Model RedisUpdateProperties has a new parameter update_channel

14.2.0 (2023-06-16)

Features Added

• Model ExportRDBParameters has a new parameter storage_subscription_id
• Model ImportRDBParameters has a new parameter storage_subscription_id
• Model RedisCommonPropertiesRedisConfiguration has a new parameter storage_subscription_id

14.1.0 (2022-10-28)

Features Added

• Model RedisLinkedServerCreateParameters has a new parameter geo_replicated_primary_host_name
• Model RedisLinkedServerCreateParameters has a new parameter primary_host_name
• Model RedisLinkedServerCreateProperties has a new parameter geo_replicated_primary_host_name
• Model RedisLinkedServerCreateProperties has a new parameter primary_host_name
• Model RedisLinkedServerProperties has a new parameter geo_replicated_primary_host_name
• Model RedisLinkedServerProperties has a new parameter primary_host_name
• Model RedisLinkedServerWithProperties has a new parameter geo_replicated_primary_host_name
• Model RedisLinkedServerWithProperties has a new parameter primary_host_name

14.0.0 (2022-09-05)

Features Added

• Added operation group AsyncOperationStatusOperations
• Model ExportRDBParameters has a new parameter preferred_data_archive_auth_method
• Model ImportRDBParameters has a new parameter preferred_data_archive_auth_method
• Model RedisCommonPropertiesRedisConfiguration has a new parameter aof_backup_enabled
• Model RedisCommonPropertiesRedisConfiguration has a new parameter authnotrequired
• Model RedisCommonPropertiesRedisConfiguration has a new parameter zonal_configuration
• Model RedisPatchSchedule has a new parameter location

Breaking Changes

• Renamed operation LinkedServerOperations.delete to LinkedServerOperations.begin_delete
• Renamed operation RedisOperations.update to RedisOperations.begin_update

13.1.0 (2021-12-16)

Features

• Model RedisResource has a new parameter identity
• Model RedisUpdateParameters has a new parameter identity
• Model RedisCreateParameters has a new parameter identity

13.0.0 (2021-07-16)

Features

• Model RedisUpdateProperties has a new parameter redis_version
• Model RedisUpdateProperties has a new parameter replicas_per_primary
• Model RedisUpdateProperties has a new parameter public_network_access
• Model RedisCommonProperties has a new parameter redis_version
• Model RedisCommonProperties has a new parameter replicas_per_primary
• Model RedisCommonProperties has a new parameter public_network_access
• Model RedisFirewallRuleCreateParameters has a new parameter type
• Model RedisFirewallRuleCreateParameters has a new parameter name
• Model RedisFirewallRuleCreateParameters has a new parameter id
• Model RedisProperties has a new parameter private_endpoint_connections
• Model RedisProperties has a new parameter replicas_per_primary
• Model RedisProperties has a new parameter public_network_access
• Model RedisCreateProperties has a new parameter redis_version
• Model RedisCreateProperties has a new parameter replicas_per_primary
• Model RedisCreateProperties has a new parameter public_network_access
• Model RedisUpdateParameters has a new parameter redis_version
• Model RedisUpdateParameters has a new parameter replicas_per_primary
• Model RedisUpdateParameters has a new parameter public_network_access
• Model RedisResource has a new parameter private_endpoint_connections
• Model RedisResource has a new parameter replicas_per_primary
• Model RedisResource has a new parameter public_network_access
• Model RedisInstanceDetails has a new parameter is_primary
• Model RedisCreateParameters has a new parameter redis_version
• Model RedisCreateParameters has a new parameter replicas_per_primary
• Model RedisCreateParameters has a new parameter public_network_access
• Added operation RedisOperations.list_by_subscription
• Added operation FirewallRulesOperations.list
• Added operation group PrivateLinkResourcesOperations
• Added operation group PrivateEndpointConnectionsOperations

Breaking changes

• Removed operation RedisOperations.list
• Removed operation FirewallRulesOperations.list_by_redis_resource

12.0.0 (2020-11-25)

12.0.0b1 (2020-10-12)

This is beta preview version.

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

General breaking changes

• Credential system has been completly revamped:

  • azure.common.credentials or msrestazure.azure_active_directory instances are no longer supported, use the azure-identity classes instead: https://pypi.org/project/azure-identity/
  • credentials parameter has been renamed credential

• The config attribute no longer exists on a client, configuration should be passed as kwarg. Example: MyClient(credential, subscription_id, enable_logging=True). For a complete set of supported options, see the parameters accept in init documentation of azure-core

• You can't import a version module anymore, use __version__ instead

• Operations that used to return a msrest.polling.LROPoller now returns a azure.core.polling.LROPoller and are prefixed with begin_.

• Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError (CloudError has been removed).

• Most of the operation kwarg have changed. Some of the most noticeable:

  • raw has been removed. Equivalent feature can be found using cls, a callback that will give access to internal HTTP response for advanced user
  • For a complete set of supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blo