1# Release History
2
3## 9.0.0 (2021-05-24)
4
5**Features**
6
7  - Model EventHubEventSubscriptionDestination has a new parameter delivery_attribute_mappings
8  - Model StorageQueueEventSubscriptionDestination has a new parameter queue_message_time_to_live_in_seconds
9  - Model TopicTypeInfo has a new parameter supported_scopes_for_source
10  - Model Topic has a new parameter extended_location
11  - Model Topic has a new parameter kind
12  - Model Topic has a new parameter system_data
13  - Model Topic has a new parameter identity
14  - Model Topic has a new parameter sku
15  - Model EventSubscriptionFilter has a new parameter enable_advanced_filtering_on_arrays
16  - Model AzureFunctionEventSubscriptionDestination has a new parameter delivery_attribute_mappings
17  - Model EventSubscriptionUpdateParameters has a new parameter dead_letter_with_resource_identity
18  - Model EventSubscriptionUpdateParameters has a new parameter delivery_with_resource_identity
19  - Model ServiceBusQueueEventSubscriptionDestination has a new parameter delivery_attribute_mappings
20  - Model DomainTopic has a new parameter system_data
21  - Model DomainUpdateParameters has a new parameter sku
22  - Model DomainUpdateParameters has a new parameter identity
23  - Model HybridConnectionEventSubscriptionDestination has a new parameter delivery_attribute_mappings
24  - Model TopicUpdateParameters has a new parameter sku
25  - Model TopicUpdateParameters has a new parameter identity
26  - Model ServiceBusTopicEventSubscriptionDestination has a new parameter delivery_attribute_mappings
27  - Model Domain has a new parameter sku
28  - Model Domain has a new parameter system_data
29  - Model Domain has a new parameter identity
30  - Model EventSubscription has a new parameter dead_letter_with_resource_identity
31  - Model EventSubscription has a new parameter system_data
32  - Model EventSubscription has a new parameter delivery_with_resource_identity
33  - Model WebHookEventSubscriptionDestination has a new parameter delivery_attribute_mappings
34  - Added operation TopicsOperations.begin_regenerate_key
35  - Added operation EventSubscriptionsOperations.get_delivery_attributes
36  - Added operation group PartnerRegistrationsOperations
37  - Added operation group SystemTopicsOperations
38  - Added operation group EventChannelsOperations
39  - Added operation group PartnerNamespacesOperations
40  - Added operation group ExtensionTopicsOperations
41  - Added operation group PartnerTopicsOperations
42  - Added operation group PartnerTopicEventSubscriptionsOperations
43  - Added operation group SystemTopicEventSubscriptionsOperations
44
45**Breaking changes**
46
47  - Removed operation TopicsOperations.regenerate_key
48
49## 8.0.0 (2020-12-21)
50
51**Breaking changes**
52
53  - Operation TopicsOperations.regenerate_key has a new signature
54  - Operation DomainsOperations.regenerate_key has a new signature
55
56## 8.0.0b1 (2020-10-31)
57
58This is beta preview version.
59For detailed changelog please refer to equivalent stable version 3.0.0rc8(https://pypi.org/project/azure-mgmt-eventgrid/3.0.0rc8/)
60
61This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
62
63**General breaking changes**
64
65- Credential system has been completly revamped:
66
67  - `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/
68  - `credentials` parameter has been renamed `credential`
69
70- 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
71  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
72- You can't import a `version` module anymore, use `__version__` instead
73- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
74- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
75- Most of the operation kwarg have changed. Some of the most noticeable:
76
77  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
78  - 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/master/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
79
80**General new features**
81
82- Type annotations support using `typing`. SDKs are mypy ready.
83- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
84- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/core/azure-core-tracing-opentelemetry) for an overview.
85
86## 3.0.0rc8 (2020-06-05)
87
88**Breaking changes**
89
90  - Model EventSubscriptionUpdateParameters no longer has parameter dead_letter_with_resource_identity
91  - Model EventSubscriptionUpdateParameters no longer has parameter delivery_with_resource_identity
92  - Model DomainUpdateParameters no longer has parameter sku
93  - Model DomainUpdateParameters no longer has parameter identity
94  - Model Domain no longer has parameter sku
95  - Model Domain no longer has parameter identity
96  - Model EventSubscription no longer has parameter dead_letter_with_resource_identity
97  - Model EventSubscription no longer has parameter delivery_with_resource_identity
98  - Model TopicUpdateParameters no longer has parameter sku
99  - Model TopicUpdateParameters no longer has parameter identity
100  - Model Topic no longer has parameter sku
101  - Model Topic no longer has parameter identity
102  - Removed operation group ExtensionTopicsOperations
103  - Removed operation group PartnerNamespacesOperations
104  - Removed operation group PartnerRegistrationsOperations
105  - Removed operation group PartnerTopicsOperations
106  - Removed operation group SystemTopicEventSubscriptionsOperations
107  - Removed operation group SystemTopicsOperations
108  - Removed operation group PartnerTopicEventSubscriptionsOperations
109  - Removed operation group EventChannelsOperations
110
111## 3.0.0rc7 (2020-05-14)
112
113**Features**
114
115  - Model PartnerTopic has a new parameter expiration_time_if_not_activated_utc
116  - Model PartnerTopic has a new parameter partner_topic_friendly_description
117  - Model EventChannel has a new parameter partner_topic_readiness_state
118  - Model EventChannel has a new parameter expiration_time_if_not_activated_utc
119  - Model EventChannel has a new parameter partner_topic_friendly_description
120  - Model PartnerRegistration has a new parameter partner_customer_service_number
121  - Model PartnerRegistration has a new parameter partner_customer_service_extension
122  - Model PartnerRegistration has a new parameter long_description
123  - Model PartnerRegistration has a new parameter customer_service_uri
124
125**Breaking changes**
126
127  - Model EventChannelFilter has a new signature
128
129## 3.0.0rc6 (2020-04-03)
130
131**Features**
132
133  - Model PartnerRegistrationUpdateParameters has a new parameter tags
134  - Model EventChannel has a new parameter filter
135
136**Breaking changes**
137
138  - Operation PrivateEndpointConnectionsOperations.update has a new signature
139  - Operation SystemTopicEventSubscriptionsOperations.list_by_system_topic has a new signature
140  - Operation PartnerTopicEventSubscriptionsOperations.list_by_partner_topic has a new signature
141
142## 3.0.0rc5 (2020-03-19)
143
144**Features**
145
146- Model Domain has a new parameter public_network_access
147- Model Domain has a new parameter identity
148- Model Domain has a new parameter private_endpoint_connections
149- Model Domain has a new parameter sku
150- Model DomainUpdateParameters has a new parameter public_network_access
151- Model DomainUpdateParameters has a new parameter identity
152- Model DomainUpdateParameters has a new parameter sku
153- Model TopicUpdateParameters has a new parameter public_network_access
154- Model TopicUpdateParameters has a new parameter identity
155- Model TopicUpdateParameters has a new parameter sku
156- Model EventSubscriptionUpdateParameters has a new parameter dead_letter_with_resource_identity
157- Model EventSubscriptionUpdateParameters has a new parameter delivery_with_resource_identity
158- Model Topic has a new parameter public_network_access
159- Model Topic has a new parameter identity
160- Model Topic has a new parameter private_endpoint_connections
161- Model Topic has a new parameter sku
162- Model EventSubscription has a new parameter dead_letter_with_resource_identity
163- Model EventSubscription has a new parameter delivery_with_resource_identity
164- Added operation group PrivateLinkResourcesOperations
165- Added operation group SystemTopicsOperations
166- Added operation group PrivateEndpointConnectionsOperations
167- Added operation group PartnerTopicsOperations
168- Added operation group PartnerNamespacesOperations
169- Added operation group PartnerTopicEventSubscriptionsOperations
170- Added operation group PartnerRegistrationsOperations
171- Added operation group ExtensionTopicsOperations
172- Added operation group SystemTopicEventSubscriptionsOperations
173- Added operation group EventChannelsOperations
174
175**Breaking changes**
176
177- Model Domain no longer has parameter allow_traffic_from_all_ips
178- Model DomainUpdateParameters no longer has parameter allow_traffic_from_all_ips
179- Model TopicUpdateParameters no longer has parameter allow_traffic_from_all_ips
180- Model Topic no longer has parameter allow_traffic_from_all_ips
181
182## 3.0.0rc4 (2020-01-17)
183
184**Features**
185
186  - Model DomainUpdateParameters has a new parameter
187    allow_traffic_from_all_ips
188  - Model DomainUpdateParameters has a new parameter inbound_ip_rules
189  - Model TopicUpdateParameters has a new parameter
190    allow_traffic_from_all_ips
191  - Model TopicUpdateParameters has a new parameter inbound_ip_rules
192
193**Breaking changes**
194
195  - Operation DomainsOperations.update has a new signature
196  - Operation TopicsOperations.update has a new signature
197
198## 3.0.0rc3 (2020-01-12)
199
200**Features**
201
202  - Model Domain has a new parameter allow_traffic_from_all_ips
203  - Model Domain has a new parameter inbound_ip_rules
204  - Model Topic has a new parameter allow_traffic_from_all_ips
205  - Model Topic has a new parameter inbound_ip_rules
206  - Model TopicTypeInfo has a new parameter source_resource_format
207
208## 3.0.0rc2 (2019-11-11)
209
210**Features**
211
212  - Model WebHookEventSubscriptionDestination has a new parameter
213    azure_active_directory_tenant_id
214
215## 3.0.0rc1 (2019-10-24)
216
217**Features**
218
219  - Model Domain has a new parameter input_schema
220  - Model Domain has a new parameter input_schema_mapping
221  - Model Domain has a new parameter metric_resource_id
222  - Model EventSubscription has a new parameter event_delivery_schema
223  - Model Topic has a new parameter input_schema
224  - Model Topic has a new parameter input_schema_mapping
225  - Model Topic has a new parameter metric_resource_id
226  - Model WebHookEventSubscriptionDestination has a new parameter
227    preferred_batch_size_in_kilobytes
228  - Model WebHookEventSubscriptionDestination has a new parameter
229    azure_active_directory_application_id_or_uri
230  - Model WebHookEventSubscriptionDestination has a new parameter
231    max_events_per_batch
232  - Model EventSubscriptionUpdateParameters has a new parameter
233    event_delivery_schema
234
235**General Breaking Changes**
236
237This version uses a next-generation code generator that *might*
238introduce breaking changes. In summary, some modules were incorrectly
239visible/importable and have been renamed. This fixed several issues
240caused by usage of classes that were not supposed to be used in the
241first place.
242
243  - EventGridManagementClient cannot be imported from
244    `azure.mgmt.eventgrid.event_grid_management_client` anymore
245    (import from `azure.mgmt.eventgrid` works like before)
246  - EventGridManagementClientConfiguration import has been moved from
247    `azure.mgmt.eventgrid.event_grid_management_client` to
248    `azure.mgmt.eventgrid`
249  - A model `MyClass` from a "models" sub-module cannot be imported
250    anymore using `azure.mgmt.eventgrid.models.my_class` (import from
251    `azure.mgmt.eventgrid.models` works like before)
252  - An operation class `MyClassOperations` from an `operations`
253    sub-module cannot be imported anymore using
254    `azure.mgmt.eventgrid.operations.my_class_operations` (import
255    from `azure.mgmt.eventgrid.operations` works like before)
256
257Last but not least, HTTP connection pooling is now enabled by default.
258You should always use a client as a context manager, or call close(), or
259use no more than one client per process.
260
261## 2.1.0 (2019-05-22)
262
263Not all preview features of the 2.1.0rc1 were confirmed in this 2.1.0
264stable version. In particular, the following features will still be
265available only in the 2.1.0rc1 for now:
266
267  - Input mapping/Delivery Schema.
268  - "label" filtering parameter in all operations
269
270All other features are now considerd stable to use in production. This
271includes:
272
273  - Domains, which include all domain related operation including
274    adding/deleting domain topics manually.
275  - Pagination/filtering
276  - Servicebus queue as destination
277  - Advanced filtering, which was introduced in previous preview
278    version.
279  - Showing and selecting default event types instead of ‘all’
280
281## 2.1.0rc1 (2019-03-11)
282
283**Disclaimer**
284
285Preview features that were on 2.0.0rc2 only and not on 2.0.0 has been
286ported in this version.
287
288This version also adds the following preview features: - Manual
289Add/delete of domain topics. - Pagination/search filtering for list
290operations. - Adding service bus queue as destination
291
292## 2.0.0 (2019-02-01)
293
294**Disclaimer**
295
296Not all preview features of the 2.0.0rc2 were confirmed in this 2.0.0
297stable version. In particular, the following features will still be
298available only in the 2.0.0rc2 for now:
299
300  - Domains.
301  - Advanced filters support.
302  - Event subscription expiration date
303  - Input mapping and event delivery schema.
304
305All other features are now considerd stable to use in production. This
306includes:
307
308  - Deadletter destination.
309  - Storage queue as destination.
310  - Hybrid connection as destination.
311  - Retry policy.
312  - Manual handshake.
313
314## 2.0.0rc2 (2018-10-24)
315
316**Features**
317
318  - Model EventSubscriptionFilter has a new parameter advanced_filters
319  - Model EventSubscriptionUpdateParameters has a new parameter
320    expiration_time_utc
321  - Model EventSubscription has a new parameter expiration_time_utc
322  - Added operation EventSubscriptionsOperations.list_by_domain_topic
323  - Added operation group DomainTopicsOperations
324  - Added operation group DomainsOperations
325
326Internal API version is 2018-09-15-preview
327
328## 2.0.0rc1 (2018-05-04)
329
330**Features**
331
332  - input mappings for topics
333  - CloudEvents support for topics
334  - customizable delivery schemas
335  - delivering events to Azure Storage queue and Azure hybrid
336    connections
337  - deadlettering
338  - retry policies
339  - manual subscription validation handshake validation.
340
341Internal API version is 2018-05-01-preview
342
343## 1.0.0 (2018-04-26)
344
345**General Breaking changes**
346
347This version uses a next-generation code generator that *might*
348introduce breaking changes.
349
350  - Model signatures now use only keyword-argument syntax. All
351    positional arguments must be re-written as keyword-arguments. To
352    keep auto-completion in most cases, models are now generated for
353    Python 2 and Python 3. Python 3 uses the "*" syntax for
354    keyword-only arguments.
355  - Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
356    improve the behavior when unrecognized enum values are encountered.
357    While this is not a breaking change, the distinctions are important,
358    and are documented here:
359    <https://docs.python.org/3/library/enum.html#others> At a glance:
360      - "is" should not be used at all.
361      - "format" will return the string value, where "%s" string
362        formatting will return `NameOfEnum.stringvalue`. Format syntax
363        should be prefered.
364  - New Long Running Operation:
365      - Return type changes from
366        `msrestazure.azure_operation.AzureOperationPoller` to
367        `msrest.polling.LROPoller`. External API is the same.
368      - Return type is now **always** a `msrest.polling.LROPoller`,
369        regardless of the optional parameters used.
370      - The behavior has changed when using `raw=True`. Instead of
371        returning the initial call result as `ClientRawResponse`,
372        without polling, now this returns an LROPoller. After polling,
373        the final resource will be returned as a `ClientRawResponse`.
374      - New `polling` parameter. The default behavior is
375        `Polling=True` which will poll using ARM algorithm. When
376        `Polling=False`, the response of the initial call will be
377        returned without polling.
378      - `polling` parameter accepts instances of subclasses of
379        `msrest.polling.PollingMethod`.
380      - `add_done_callback` will no longer raise if called after
381        polling is finished, but will instead execute the callback right
382        away.
383
384**Features**
385
386  - Client class can be used as a context manager to keep the underlying
387    HTTP session open for performance
388
389## 0.4.0 (2018-01-16)
390
391**Breaking changes**
392
393  - EventSubscription create is renamed to create_or_update.
394  - Regenerated SDK based on 2018-01-01 API version.
395  - OperationOrigin enum is removed. Origin of the operation is now a
396    string.
397
398## 0.3.0 (2017-11-02)
399
400**Features**
401
402  - Support for updating Topic properties
403
404## 0.2.0 (2017-09-13)
405
406**Breaking changes**
407
408  - Use WebHookEventSubscriptionDestination for webhook endpoint URLs.
409  - Regenerated based on 2017-09-15-preview version
410
411## 0.1.1 (2017-08-17)
412
413**Bugfixes**
414
415  - Fix unexpected exception in some delete call
416
417## 0.1.0 (2017-08-17)
418
419  - Initial Release
420