1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
|
# Release History
## 3.0.0 (2024-06-24)
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](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- 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/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
**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](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.
### Features Added
- Added operation group PowerBIEmbeddedManagementClientOperationsMixin
### Breaking Changes
- Operation WorkspaceCollectionsOperations.check_name_availability has a new required parameter body
- Operation WorkspaceCollectionsOperations.check_name_availability has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.check_name_availability no longer has parameter name
- Operation WorkspaceCollectionsOperations.check_name_availability no longer has parameter type
- Operation WorkspaceCollectionsOperations.create has a new required parameter body
- Operation WorkspaceCollectionsOperations.create has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.create no longer has parameter location
- Operation WorkspaceCollectionsOperations.create no longer has parameter tags
- Operation WorkspaceCollectionsOperations.get_access_keys has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.get_by_name has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.list_by_resource_group has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.list_by_subscription has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.migrate has a new required parameter body
- Operation WorkspaceCollectionsOperations.migrate has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.migrate no longer has parameter resources
- Operation WorkspaceCollectionsOperations.migrate no longer has parameter target_resource_group
- Operation WorkspaceCollectionsOperations.regenerate_key has a new required parameter body
- Operation WorkspaceCollectionsOperations.regenerate_key has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.regenerate_key no longer has parameter key_name
- Operation WorkspaceCollectionsOperations.update has a new required parameter body
- Operation WorkspaceCollectionsOperations.update has a new required parameter kwargs
- Operation WorkspaceCollectionsOperations.update no longer has parameter tags
- Operation WorkspacesOperations.list has a new required parameter kwargs
- Renamed operation WorkspaceCollectionsOperations.delete to WorkspaceCollectionsOperations.begin_delete
## 2.0.0 (2018-05-25)
**Features**
- Client class can be used as a context manager to keep the underlying
HTTP session open for performance
**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.
**Bugfixes**
- Compatibility of the sdist with wheel 0.31.0
## 1.0.0 (2017-06-23)
- Initial stable release
This wheel package is now built with the azure wheel extension
|