Microsoft Azure Relay Client Library for Python
This is the Microsoft Azure Relay Client Library.
Azure Resource Manager (ARM) is the next generation of management APIs that replace the old Azure Service Management (ASM).
This package has been tested with Python 2.7, 3.4, 3.5, 3.6 and 3.7.
For the older Azure Service Management (ASM) libraries, see azure-servicemanagement-legacy library.
For a more complete set of Azure libraries, see the azure sdk python release.
To learn how to use this package, see the quickstart guide
For docs and references, see Python SDK References Code samples for this package can be found at Relay Management on docs.microsoft.com. Additional code samples for different Azure services are available at Samples Repo
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
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.Note
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