|
| 1 | +# Release History |
| 2 | + |
| 3 | +## 4.6.1 (Unreleased) |
| 4 | + |
| 5 | +### Features Added |
| 6 | + |
| 7 | +### Breaking Changes |
| 8 | + |
| 9 | +### Bugs Fixed |
| 10 | + |
| 11 | +### Other Changes |
| 12 | + |
| 13 | +## 4.6.0 (2021-10-05) |
| 14 | + |
| 15 | +### Features Added |
| 16 | + |
| 17 | +- Added new enum values to `SystemEvents`. |
| 18 | + |
| 19 | +## 4.5.0 (2021-08-10) |
| 20 | + |
| 21 | +### Features Added |
| 22 | + |
| 23 | +- Added a new enum value `Microsoft.ContainerService.NewKubernetesVersionAvailable` to `SystemEvents`. |
| 24 | +- Added a `from_json` method which now accepts storage QueueMessage, eventhub's EventData or ServiceBusMessage or simply json bytes to return an `EventGridEvent` |
| 25 | + |
| 26 | +## 4.4.0 (2021-07-19) |
| 27 | + |
| 28 | +- Bumped `msrest` dependency to `0.6.21` to align with mgmt package. |
| 29 | + |
| 30 | +### Features Added |
| 31 | + |
| 32 | +- `EventGridPublisherClient` now supports Azure Active Directory (AAD) for authentication. |
| 33 | + |
| 34 | +## 4.3.0 (2021-06-09) |
| 35 | + |
| 36 | + **New Features** |
| 37 | + - Added new event names related to blob inventory to the `SystemEventNames` enum. |
| 38 | + |
| 39 | + **Bug Fixes** |
| 40 | + - Replaced the `ServiceBusDeadletterMessagesAvailableWithNoListenerEventName` with the right value. |
| 41 | + |
| 42 | +## 4.2.0 (2021-05-12) |
| 43 | + |
| 44 | + **New Features** |
| 45 | + - Added new event names to the `SystemEventNames` enum. |
| 46 | + |
| 47 | +## 4.1.1 (2021-04-07) |
| 48 | + |
| 49 | + **Bug Fixes** |
| 50 | + - Improved the `repr` on `EventGridEvent` to show more meaningful text. |
| 51 | + |
| 52 | +## 4.1.0 (2021-03-23) |
| 53 | + |
| 54 | + **New Features** |
| 55 | + - Added new SystemEventNames `AcsChatThreadParticipantRemovedEventName`, `AcsChatThreadParticipantAddedEventName` and `AcsRecordingFileStatusUpdatedEventName`. |
| 56 | + |
| 57 | +## 4.0.0 (2021-03-09) |
| 58 | + |
| 59 | + **Note:** This is the first stable release of our efforts to create a user-friendly and Pythonic client library for Azure EventGrid. Users migrating from `v1.x` are advised to view the [migration guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/migration_guide.md). |
| 60 | + |
| 61 | + **New Features** |
| 62 | + - `azure-eventgrid` package now supports `azure.core.messaging.CloudEvent` which honors the CNCF CloudEvent spec. |
| 63 | + - `azure.eventgrid.SystemEventNames` can be used to get the event model type mapping for system events. |
| 64 | + - Implements the `EventGridPublisherClient` for the publish flow for EventGrid Events, CloudEvents and Custom schema events. |
| 65 | + |
| 66 | + **Breaking Changes** |
| 67 | + - `azure.eventgrid.models` namespace along with all the models in it are now removed.: |
| 68 | + - JSON documentation on the events is available here: https://docs.microsoft.com/azure/event-grid/system-topics |
| 69 | + - `azure.eventgrid.SystemEventNames` provides the list of available events name for easy switching. |
| 70 | + - `azure.eventgrid.event_grid_client.EventGridClient` is now removed in favor of `azure.eventgrid.EventGridPublisherClient`. |
| 71 | + - `azure.eventgrid.event_grid_client.EventGridClientConfiguration` is now removed. |
| 72 | + |
| 73 | + |
| 74 | +## 2.0.0 (2021-03-09) |
| 75 | + |
| 76 | + **Disclaimer:** v2.0.0 is functionally equivalent to v4.0.0. Users are advised to use v4.0.0 instead of this. |
| 77 | + |
| 78 | + **Breaking Changes** |
| 79 | + - `~azure.eventgrid.CloudEvent` is now removed in favor of `~azure.core.messaging.CloudEvent`. |
| 80 | + - All the `SystemEventNames` related to Azure Communication Service starting with `ACS****` are renamed to `Acs***` to honor pascal case. |
| 81 | + |
| 82 | + **Features** |
| 83 | + - Added support for two new `SystemEvents` - `ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData` and `ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData` |
| 84 | + |
| 85 | +## 2.0.0b5 (2021-02-10) |
| 86 | + |
| 87 | + **Breaking Changes** |
| 88 | + - `EventGridSharedAccessSignatureCredential` is deprecated in favor of `AzureSasCredential`. |
| 89 | + - `azure.eventgrid.models` namespace along with all the models in it are now removed. `azure.eventgrid.SystemEventNames` can be used to get the event model type mapping. |
| 90 | + - `topic_hostname` is renamed to `endpoint` in the `EventGridPublisherClient`. |
| 91 | + - `azure.eventgrid.generate_shared_access_signature` method is now renamed to `generate_sas`. |
| 92 | + - `EventGridConsumer`is now removed. Please see the samples to see how events can be deserialized. |
| 93 | + - `CustomEvent` model is removed. Dictionaries must be used to send a custom schema. |
| 94 | + |
| 95 | + **Bug Fixes** |
| 96 | + - `EventGridEvent` has two additional required positional parameters namely, `data` and `data_version`. |
| 97 | + - `EventGridPublisherClient` now appropriately throws a `ValueError` if an invalid credential is passed during initialization. |
| 98 | + |
| 99 | +## 2.0.0b4 (2020-11-11) |
| 100 | + |
| 101 | + **Bug Fixes** |
| 102 | + - `TypeError` is raised when bytes are passed to an `EventGridEvent`. |
| 103 | + |
| 104 | +## 2.0.0b3 (2020-10-05) |
| 105 | + |
| 106 | + **Feature** |
| 107 | + - Added support for Keyvault Event Types |
| 108 | + - Added distributed tracing support for CloudEvents |
| 109 | + |
| 110 | +## 2.0.0b2 (2020-09-24) |
| 111 | + |
| 112 | + **Features** |
| 113 | + - Added support for Azure Communication Services event types. |
| 114 | + |
| 115 | +## 2.0.0b1 (2020-09-08) |
| 116 | + |
| 117 | + **Features** |
| 118 | + - Version (2.0.0b1) is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure EventGrid. |
| 119 | + For more information about this, and preview releases of other Azure SDK libraries, please visit https://azure.github.io/azure-sdk/releases/latest/python.html. |
| 120 | + - Added Support for `CloudEvents`. |
| 121 | + - Implements the `EventGridPublisherClient` for the publish flow for EventGrid Events, CloudEvents and CustomEvents. |
| 122 | + - Implements the `EventGridConsumer` for the consume flow of the events. |
| 123 | + |
| 124 | +## 1.3.0 (2019-05-20) |
| 125 | + |
| 126 | + - Event Schemas for new event types from IotHub, Media Services, |
| 127 | + Container Registry, Maps, and AppConfiguration services. |
| 128 | + |
| 129 | +## 1.2.0 (2018-08-28) |
| 130 | + |
| 131 | + - Event Schemas for new events (IotHub DeviceConnected and |
| 132 | + DeviceDisconnected events, Resource events related to actions), and |
| 133 | + breaking changes to the schema for IotHub DeviceCreated event and |
| 134 | + IotHub DeviceDeleted event. |
| 135 | + |
| 136 | +## 1.1.0 (2018-05-24) |
| 137 | + |
| 138 | + - Event Schemas for EventGrid subscription validation event, Azure |
| 139 | + Media events, and ServiceBus events. |
| 140 | + |
| 141 | +## 1.0.0 (2018-04-26) |
| 142 | + |
| 143 | +**General Breaking changes** |
| 144 | + |
| 145 | +This version uses a next-generation code generator that *might* |
| 146 | +introduce breaking changes. |
| 147 | + |
| 148 | + - Model signatures now use only keyword-argument syntax. All |
| 149 | + positional arguments must be re-written as keyword-arguments. To |
| 150 | + keep auto-completion in most cases, models are now generated for |
| 151 | + Python 2 and Python 3. Python 3 uses the "*" syntax for |
| 152 | + keyword-only arguments. |
| 153 | + - Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to |
| 154 | + improve the behavior when unrecognized enum values are encountered. |
| 155 | + While this is not a breaking change, the distinctions are important, |
| 156 | + and are documented here: |
| 157 | + <https://docs.python.org/3/library/enum.html#others> At a glance: |
| 158 | + - "is" should not be used at all. |
| 159 | + - "format" will return the string value, where "%s" string |
| 160 | + formatting will return `NameOfEnum.stringvalue`. Format syntax |
| 161 | + should be prefered. |
| 162 | + - New Long Running Operation: |
| 163 | + - Return type changes from |
| 164 | + `msrestazure.azure_operation.AzureOperationPoller` to |
| 165 | + `msrest.polling.LROPoller`. External API is the same. |
| 166 | + - Return type is now **always** a `msrest.polling.LROPoller`, |
| 167 | + regardless of the optional parameters used. |
| 168 | + - The behavior has changed when using `raw=True`. Instead of |
| 169 | + returning the initial call result as `ClientRawResponse`, |
| 170 | + without polling, now this returns an LROPoller. After polling, |
| 171 | + the final resource will be returned as a `ClientRawResponse`. |
| 172 | + - New `polling` parameter. The default behavior is |
| 173 | + `Polling=True` which will poll using ARM algorithm. When |
| 174 | + `Polling=False`, the response of the initial call will be |
| 175 | + returned without polling. |
| 176 | + - `polling` parameter accepts instances of subclasses of |
| 177 | + `msrest.polling.PollingMethod`. |
| 178 | + - `add_done_callback` will no longer raise if called after |
| 179 | + polling is finished, but will instead execute the callback right |
| 180 | + away. |
| 181 | + |
| 182 | +**Features** |
| 183 | + |
| 184 | + - Client class can be used as a context manager to keep the underlying |
| 185 | + HTTP session open for performance |
| 186 | + - Support for consuming Azure Container Registry events and Azure IoT |
| 187 | + Hub events published to Event Grid. |
| 188 | + |
| 189 | +## 0.1.0 (2018-01-30) |
| 190 | + |
| 191 | + - Initial Release |
0 commit comments