Package: azure-mgmt-redis
Microsoft Azure SDK for PythonThis is the Microsoft Azure Redis Cache Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-redis
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.redisimportRedisManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=RedisManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Redis Cache Managementon docs.microsoft.comAzure Python Mgmt SDK Samples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History14.3.0 (2023-09-19)Features AddedAdded operation RedisOperations.begin_flush_cacheAdded operation group AccessPolicyAssignmentOperationsAdded operation group AccessPolicyOperationsModel RedisCommonProperties has a new parameter update_channelModel RedisCommonPropertiesRedisConfiguration has a new parameter aad_enabledModel RedisCreateParameters has a new parameter update_channelModel RedisCreateProperties has a new parameter update_channelModel RedisProperties has a new parameter update_channelModel RedisResource has a new parameter update_channelModel RedisUpdateParameters has a new parameter update_channelModel RedisUpdateProperties has a new parameter update_channel14.2.0 (2023-06-16)Features AddedModel ExportRDBParameters has a new parameter storage_subscription_idModel ImportRDBParameters has a new parameter storage_subscription_idModel RedisCommonPropertiesRedisConfiguration has a new parameter storage_subscription_id14.1.0 (2022-10-28)Features AddedModel RedisLinkedServerCreateParameters has a new parameter geo_replicated_primary_host_nameModel RedisLinkedServerCreateParameters has a new parameter primary_host_nameModel RedisLinkedServerCreateProperties has a new parameter geo_replicated_primary_host_nameModel RedisLinkedServerCreateProperties has a new parameter primary_host_nameModel RedisLinkedServerProperties has a new parameter geo_replicated_primary_host_nameModel RedisLinkedServerProperties has a new parameter primary_host_nameModel RedisLinkedServerWithProperties has a new parameter geo_replicated_primary_host_nameModel RedisLinkedServerWithProperties has a new parameter primary_host_name14.0.0 (2022-09-05)Features AddedAdded operation group AsyncOperationStatusOperationsModel ExportRDBParameters has a new parameter preferred_data_archive_auth_methodModel ImportRDBParameters has a new parameter preferred_data_archive_auth_methodModel RedisCommonPropertiesRedisConfiguration has a new parameter aof_backup_enabledModel RedisCommonPropertiesRedisConfiguration has a new parameter authnotrequiredModel RedisCommonPropertiesRedisConfiguration has a new parameter zonal_configurationModel RedisPatchSchedule has a new parameter locationBreaking ChangesRenamed operation LinkedServerOperations.delete to LinkedServerOperations.begin_deleteRenamed operation RedisOperations.update to RedisOperations.begin_update13.1.0 (2021-12-16)FeaturesModel RedisResource has a new parameter identityModel RedisUpdateParameters has a new parameter identityModel RedisCreateParameters has a new parameter identity13.0.0 (2021-07-16)FeaturesModel RedisUpdateProperties has a new parameter redis_versionModel RedisUpdateProperties has a new parameter replicas_per_primaryModel RedisUpdateProperties has a new parameter public_network_accessModel RedisCommonProperties has a new parameter redis_versionModel RedisCommonProperties has a new parameter replicas_per_primaryModel RedisCommonProperties has a new parameter public_network_accessModel RedisFirewallRuleCreateParameters has a new parameter typeModel RedisFirewallRuleCreateParameters has a new parameter nameModel RedisFirewallRuleCreateParameters has a new parameter idModel RedisProperties has a new parameter private_endpoint_connectionsModel RedisProperties has a new parameter replicas_per_primaryModel RedisProperties has a new parameter public_network_accessModel RedisCreateProperties has a new parameter redis_versionModel RedisCreateProperties has a new parameter replicas_per_primaryModel RedisCreateProperties has a new parameter public_network_accessModel RedisUpdateParameters has a new parameter redis_versionModel RedisUpdateParameters has a new parameter replicas_per_primaryModel RedisUpdateParameters has a new parameter public_network_accessModel RedisResource has a new parameter private_endpoint_connectionsModel RedisResource has a new parameter replicas_per_primaryModel RedisResource has a new parameter public_network_accessModel RedisInstanceDetails has a new parameter is_primaryModel RedisCreateParameters has a new parameter redis_versionModel RedisCreateParameters has a new parameter replicas_per_primaryModel RedisCreateParameters has a new parameter public_network_accessAdded operation RedisOperations.list_by_subscriptionAdded operation FirewallRulesOperations.listAdded operation group PrivateLinkResourcesOperationsAdded operation group PrivateEndpointConnectionsOperationsBreaking changesRemoved operation RedisOperations.listRemoved operation FirewallRulesOperations.list_by_redis_resource12.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 changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute 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 theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of
supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.7.0.0rc2 (2020-09-01)FeaturesModel RedisRebootParameters has a new parameter portsModel RedisInstanceDetails has a new parameter is_masterBreaking changesOperation RedisOperations.force_reboot has a new signature7.0.0rc1 (2019-12-07)FeaturesModel RedisUpdateParameters has a new parameter
replicas_per_masterModel RedisCreateParameters has a new parameter
replicas_per_masterModel RedisResource has a new parameter instancesModel RedisResource has a new parameter replicas_per_masterGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce 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 fromazure.mgmt.redis.redis_management_clientanymore (import fromazure.mgmt.redisworks like before)RedisManagementClientConfiguration import has been moved fromazure.mgmt.redis.redis_management_clienttoazure.mgmt.redisA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.redis.models.my_class(import fromazure.mgmt.redis.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.redis.operations.my_class_operations(import fromazure.mgmt.redis.operationsworks 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)Noteazure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
namespace package)FeaturesClient class can be used as a context manager to keep the underlying
HTTP session open for performanceModel RedisCreateParameters has a new parameter
minimum_tls_versionModel RedisResource has a new parameter minimum_tls_versionModel RedisUpdateParameters has a new parameter
minimum_tls_versionAdded operation PatchSchedulesOperations.list_by_redis_resourceAdded operation RedisOperations.list_upgrade_notificationsAdded operation RedisOperations.check_name_availabilityGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce 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#othersAt a glance:"is" should not be used at all."format" will return the string value, where "%s" string
formatting will returnNameOfEnum.stringvalue. Format syntax
should be prefered.New Long Running Operation:Return type changes frommsrestazure.azure_operation.AzureOperationPollertomsrest.polling.LROPoller. External API is the same.Return type is nowalwaysamsrest.polling.LROPoller,
regardless of the optional parameters used.The behavior has changed when usingraw=True. Instead of
returning the initial call result asClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as aClientRawResponse.Newpollingparameter. The default behavior isPolling=Truewhich will poll using ARM algorithm. WhenPolling=False, the response of the initial call will be
returned without polling.pollingparameter accepts instances of subclasses ofmsrest.polling.PollingMethod.add_done_callbackwill no longer raise if called after
polling is finished, but will instead execute the callback right
away.5.0.0 (2018-02-08)DisclaimerSeveral 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 changesRedisCreateParameters parameters orders shuffled (see disclaimer)RedisUpdateParameters parameters orders shuffled (see disclaimer)Merging redis_firewall_rule operations group into firewall_rulesRename firewall_rules.list to
firewall_rules.list_by_redis_resourceFeaturesAll operation groups have now a "models" attributeAdd linked_server operations groupNew ApiVersion 2017-10-014.1.1 (2017-10-25)BugfixesFix "tags" attribute in redis update4.1.0 (2017-04-18)FeaturesAdd firewall rules operationsNotesThis wheel package is now built with the azure wheel extension4.0.0 (2017-01-13)BugfixesFix error if patching when not existBreaking changeredis.updateis no longer an async operation3.0.0 (2016-11-14)New featuresAdd "Everyday" and "Weekend" to schedule enumsImprove technical documentionBreaking changeSimplifypatch_schedules.create_or_updateparameters2.0.0 (2016-10-20)Major bug fixes and refactoring.1.0.0 (2016-08-09)Initial Release (API Version 2016-04-01)