Microsoft Azure Recovery Services Client Library for Python
This is the Microsoft Azure Recovery Services Client Library. This package has been tested with Python 3.7+. For a more complete view of Azure libraries, see the azure sdk python release.
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
pip install azure-mgmt-recoveryservices
pip install azure-identity
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.recoveryservices import RecoveryServicesClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = RecoveryServicesClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Code samples for this package can be found at:
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
2023-01-01
Features
Features
Breaking changes
Features
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 userGeneral new features
typing
. SDKs are mypy ready.aio
namespace of your package to find the async client.Features
General Breaking Changes
This version uses a next-generation code generator that might introduce breaking changes. 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.
azure.mgmt.recoveryservices.cost_management_client
anymore (import from
azure.mgmt.recoveryservices
works like before)azure.mgmt.recoveryservices.cost_management_client
to azure.mgmt.recoveryservices
MyClass
from a "models" sub-module cannot be imported
anymore using azure.mgmt.recoveryservices.models.my_class
(import from
azure.mgmt.recoveryservices.models
works like before)MyClassOperations
from an operations
sub-module cannot be imported anymore using
azure.mgmt.recoveryservices.operations.my_class_operations
(import from
azure.mgmt.recoveryservices.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.
Features
Breaking Changes
Features
General Breaking changes
This version uses a next-generation code generator that might introduce breaking changes.
NameOfEnum.stringvalue
. Format syntax
should be prefered.msrestazure.azure_operation.AzureOperationPoller
to
msrest.polling.LROPoller
. External API is the same.msrest.polling.LROPoller
,
regardless of the optional parameters used.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
.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.Bugfixes
Bugfixes