azure-mgmt-redis 14.4.0

Description:

azuremgmtredis 14.4.0

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.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



General new features

Type annotations support using typing. SDKs are mypy ready.
This client has now stable and official support for async. Check the aio namespace of your package to find the async client.
This client now support natively tracing library like OpenCensus or OpenTelemetry. See this tracing quickstart for an overview.

7.0.0rc2 (2020-09-01)
Features

Model RedisRebootParameters has a new parameter ports
Model RedisInstanceDetails has a new parameter is_master

Breaking changes

Operation RedisOperations.force_reboot has a new signature

7.0.0rc1 (2019-12-07)
Features

Model RedisUpdateParameters has a new parameter
replicas_per_master
Model RedisCreateParameters has a new parameter
replicas_per_master
Model RedisResource has a new parameter instances
Model RedisResource has a new parameter replicas_per_master

General Breaking changes
This version uses a next-generation code generator that might
introduce breaking changes if from some import. In summary, some modules
were incorrectly visible/importable and have been renamed. This fixed
several issues caused by usage of classes that were not supposed to be
used in the first place.

RedisManagementClient cannot be imported from
azure.mgmt.redis.redis_management_client anymore (import from
azure.mgmt.redis works like before)
RedisManagementClientConfiguration import has been moved from
azure.mgmt.redis.redis_management_client to
azure.mgmt.redis
A model MyClass from a "models" sub-module cannot be imported
anymore using azure.mgmt.redis.models.my_class (import from
azure.mgmt.redis.models works like before)
An operation class MyClassOperations from an operations
sub-module cannot be imported anymore using
azure.mgmt.redis.operations.my_class_operations (import from
azure.mgmt.redis.operations works like before)

Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.
6.0.0 (2019-01-15)
Note

azure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
namespace package)

Features

Client class can be used as a context manager to keep the underlying
HTTP session open for performance
Model RedisCreateParameters has a new parameter
minimum_tls_version
Model RedisResource has a new parameter minimum_tls_version
Model RedisUpdateParameters has a new parameter
minimum_tls_version
Added operation PatchSchedulesOperations.list_by_redis_resource
Added operation RedisOperations.list_upgrade_notifications
Added operation RedisOperations.check_name_availability

General Breaking changes
This version uses a next-generation code generator that might
introduce breaking changes.

Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.
Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:
https://docs.python.org/3/library/enum.html#others At a glance:

"is" should not be used at all.
"format" will return the string value, where "%s" string
formatting will return NameOfEnum.stringvalue. Format syntax
should be prefered.


New Long Running Operation:

Return type changes from
msrestazure.azure_operation.AzureOperationPoller to
msrest.polling.LROPoller. External API is the same.
Return type is now always a msrest.polling.LROPoller,
regardless of the optional parameters used.
The behavior has changed when using raw=True. Instead of
returning the initial call result as ClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as a ClientRawResponse.
New polling parameter. The default behavior is
Polling=True which will poll using ARM algorithm. When
Polling=False, the response of the initial call will be
returned without polling.
polling parameter accepts instances of subclasses of
msrest.polling.PollingMethod.
add_done_callback will no longer raise if called after
polling is finished, but will instead execute the callback right
away.



5.0.0 (2018-02-08)
Disclaimer
Several model (like RedisCreateParameters) have positional arguments
shuffled, due to constraints in our code generator. This is not breaking
if you use keyword arguments. If you are using positional arguments, we
strongly suggest to use keyword only arguments for Model creation, since
next version 6.0.0 will use keyword only arguments for models.
Breaking changes

RedisCreateParameters parameters orders shuffled (see disclaimer)
RedisUpdateParameters parameters orders shuffled (see disclaimer)
Merging redis_firewall_rule operations group into firewall_rules
Rename firewall_rules.list to
firewall_rules.list_by_redis_resource

Features

All operation groups have now a "models" attribute
Add linked_server operations group

New ApiVersion 2017-10-01
4.1.1 (2017-10-25)
Bugfixes

Fix "tags" attribute in redis update

4.1.0 (2017-04-18)
Features

Add firewall rules operations

Notes

This wheel package is now built with the azure wheel extension

4.0.0 (2017-01-13)
Bugfixes

Fix error if patching when not exist

Breaking change

redis.update is no longer an async operation

3.0.0 (2016-11-14)
New features

Add "Everyday" and "Weekend" to schedule enums
Improve technical documention

Breaking change

Simplify patch_schedules.create_or_update parameters

2.0.0 (2016-10-20)

Major bug fixes and refactoring.

1.0.0 (2016-08-09)

Initial Release (API Version 2016-04-01)