Skip to content

Latest commit

 

History

History
346 lines (217 loc) · 12.8 KB

CHANGELOG.md

File metadata and controls

346 lines (217 loc) · 12.8 KB

Release History

4.22.0 (2025-05-14)

Features Added

  • Added new enum values to SystemEventNames related to Azure Communication Services and Azure Edge.

4.21.0 (2024-11-19)

Features Added

  • Added new enum values to SystemEventNames related to Azure Resource Notifications.

4.20.0 (2024-06-12)

Features Added

  • This is a GA of the EventGridConsumerClient, the EventGridConsumerClient supports the following operations for Cloud Events in Event Grid Namespace: receive, release, acknowledge, reject and renew_locks.
  • The EventGridPublisherClient now supports the Event Grid Namespace tier. Initialize the client with the namespace endpoint, and the namespace_topic kwarg to send Cloud Events to an Event Grid Namespace topic.

4.20.0b2 (2024-04-25)

This is a Beta of the EventGridClient

Bugs Fixed

  • Fixed serialization issues with CloudEvent and CNCF Cloud Event

4.20.0b1 (2024-04-11)

Features Added

  • This is a Beta of the EventGridClient
    • EventGridClient send can be used for both Event Grid Namespace Resources and Event Grid Basic Resources.
      • Added a kwarg level in the EventGridClient constructor. The default value is Standard which creates a client for an Event Grid Namespace Resource.

Breaking Changes

  • Removed the AcknowledgeOptions,ReleaseOptions, RejectOptions, and RenewLockOptions models. lock_tokens can now be specified as a kwarg on the operation.
  • Renamed publish_cloud_events to send.

4.19.0 (2024-04-10)

Features Added

  • Added new enum values to SystemEventNames related to Azure Communication Services.

Breaking Changes

  • Fixed a bug where the Api Version was being hardcoded to 2018-01-01 on any request sent to the service.

4.18.0 (2024-03-12)

Features Added

  • Added new enum values to SystemEventNames related to Azure Api Center.

4.17.0 (2024-02-08)

This version and all future versions will require Python 3.8+.

Features Added

  • Added new enums values to SystemEventNames related to Azure Storage and Azure VMware Solution.

4.17.0b1 (2023-11-09)

Features Added

  • Beta EventGridClient features were added on top of the last GA version of EventGrid.
    • Added new features to the EventGridClient that supports publish_cloud_events, receive_cloud_events, acknowledge_cloud_events , release_cloud_events, and reject_cloud_events operations. These features include a renew_cloud_event_locks operation, as well as a release_with_delay parameter on the release_cloud_events operation.
    • The lock_tokens parameter in reject_cloud_events, release_cloud_events, and acknowledge_cloud_events was renamed to reject_options, release_options, and acknowledge_options.
    • The binary_mode keyword argument on publish_cloud_events was added to allow for binary mode support when publishing single Cloud Events.
    • Added new models to support these new operations on EventGridClient.

4.16.0 (2023-11-08)

Features Added

  • Added new enum values to SystemEventnames related to Azure Resource Notifications.

4.15.0 (2023-10-12)

Features Added

  • Added new enum values to SystemEventNames related to Azure Communication Services and Azure Resource Notifications.

4.14.0 (2023-09-13)

Features Added

  • Added new enum values to SystemEventNames related to Azure App Configuration and Azure EventGrid.

4.13.0 (2023-06-08)

Features Added

  • Beta EventGridClient features were removed for this and future GA versions.
  • Added new enum values to SystemEventNames related to Azure Container Services.

4.12.0b1 (2023-05-22)

Features Added

  • Added a new EventGridClient that supports publish_cloud_events, receive_cloud_events, acknowledge_cloud_events , release_cloud_events, and reject_cloud_events operations.
  • Added new models to support these new operations on EventGridClient.

4.11.0 (2023-05-09)

Features Added

  • Added new enum values to SystemEventNames related to Storage Tasks, Azure Communication Services and Azure HealthcareApis.

4.10.0 (2023-04-11)

Features Added

  • Added new enum values to SystemEventNames related to Azure Communication Services, DataBox and ApiManagementGateway APIs.

Bugs Fixed

  • SystemEventNames enums for APIManagement were incorrectly capitalized, changed Api to API.

Other Changes

  • Removed msrest dependency and six dependency
  • Added isodate dependency

4.9.1 (2022-11-08)

  • This version and all future versions will require Python 3.7+.

Features Added

  • Added new enum values to SystemEventNames related to health care APIs.

4.9.0 (2022-07-05)

Features Added

  • Added support for publishing events to a channel.

4.9.0b1 (2022-04-07)

Features Added

  • Added support for publishing events to a channel.

4.8.0 (2022-04-06)

  • This version and all future versions will require Python 3.6+. Python 2.7 is no longer supported.

Features Added

  • Added new enum values to SystemEventNames related to health care APIs.

4.7.1 (2021-11-18)

Bugs Fixed

  • The send API will raise on exceptions.

4.7.0 (2021-11-09)

Features Added

4.6.0 (2021-10-05)

Features Added

  • Added new enum values to SystemEvents.

4.5.0 (2021-08-10)

Features Added

  • Added a new enum value Microsoft.ContainerService.NewKubernetesVersionAvailable to SystemEvents.
  • Added a from_json method which now accepts storage QueueMessage, eventhub's EventData or ServiceBusMessage or simply json bytes to return an EventGridEvent

4.4.0 (2021-07-19)

  • Bumped msrest dependency to 0.6.21 to align with mgmt package.

Features Added

  • EventGridPublisherClient now supports Azure Active Directory (AAD) for authentication.

4.3.0 (2021-06-09)

New Features

  • Added new event names related to blob inventory to the SystemEventNames enum.

Bug Fixes

  • Replaced the ServiceBusDeadletterMessagesAvailableWithNoListenerEventName with the right value.

4.2.0 (2021-05-12)

New Features

  • Added new event names to the SystemEventNames enum.

4.1.1 (2021-04-07)

Bug Fixes

  • Improved the repr on EventGridEvent to show more meaningful text.

4.1.0 (2021-03-23)

New Features

  • Added new SystemEventNames AcsChatThreadParticipantRemovedEventName, AcsChatThreadParticipantAddedEventName and AcsRecordingFileStatusUpdatedEventName.

4.0.0 (2021-03-09)

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.

New Features

  • azure-eventgrid package now supports azure.core.messaging.CloudEvent which honors the CNCF CloudEvent spec.
  • azure.eventgrid.SystemEventNames can be used to get the event model type mapping for system events.
  • Implements the EventGridPublisherClient for the publish flow for EventGrid Events, CloudEvents and Custom schema events.

Breaking Changes

  • azure.eventgrid.models namespace along with all the models in it are now removed.:
  • azure.eventgrid.event_grid_client.EventGridClient is now removed in favor of azure.eventgrid.EventGridPublisherClient.
  • azure.eventgrid.event_grid_client.EventGridClientConfiguration is now removed.

2.0.0 (2021-03-09)

Disclaimer: v2.0.0 is functionally equivalent to v4.0.0. Users are advised to use v4.0.0 instead of this.

Breaking Changes

  • ~azure.eventgrid.CloudEvent is now removed in favor of ~azure.core.messaging.CloudEvent.
  • All the SystemEventNames related to Azure Communication Service starting with ACS**** are renamed to Acs*** to honor pascal case.

Features

  • Added support for two new SystemEvents - ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData and ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData

2.0.0b5 (2021-02-10)

Breaking Changes

  • EventGridSharedAccessSignatureCredential is deprecated in favor of AzureSasCredential.
  • 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.
  • topic_hostname is renamed to endpoint in the EventGridPublisherClient.
  • azure.eventgrid.generate_shared_access_signature method is now renamed to generate_sas.
  • EventGridConsumeris now removed. Please see the samples to see how events can be deserialized.
  • CustomEvent model is removed. Dictionaries must be used to send a custom schema.

Bug Fixes

  • EventGridEvent has two additional required positional parameters namely, data and data_version.
  • EventGridPublisherClient now appropriately throws a ValueError if an invalid credential is passed during initialization.

2.0.0b4 (2020-11-11)

Bug Fixes

  • TypeError is raised when bytes are passed to an EventGridEvent.

2.0.0b3 (2020-10-05)

Feature

  • Added support for Keyvault Event Types
  • Added distributed tracing support for CloudEvents

2.0.0b2 (2020-09-24)

Features

  • Added support for Azure Communication Services event types.

2.0.0b1 (2020-09-08)

Features

  • Version (2.0.0b1) is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure EventGrid. 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.
  • Added Support for CloudEvents.
  • Implements the EventGridPublisherClient for the publish flow for EventGrid Events, CloudEvents and CustomEvents.
  • Implements the EventGridConsumer for the consume flow of the events.

1.3.0 (2019-05-20)

  • Event Schemas for new event types from IotHub, Media Services, Container Registry, Maps, and AppConfiguration services.

1.2.0 (2018-08-28)

  • Event Schemas for new events (IotHub DeviceConnected and DeviceDisconnected events, Resource events related to actions), and breaking changes to the schema for IotHub DeviceCreated event and IotHub DeviceDeleted event.

1.1.0 (2018-05-24)

  • Event Schemas for EventGrid subscription validation event, Azure Media events, and ServiceBus events.

1.0.0 (2018-04-26)

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 preferred.
  • 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.

Features

  • Client class can be used as a context manager to keep the underlying HTTP session open for performance
  • Support for consuming Azure Container Registry events and Azure IoT Hub events published to Event Grid.

0.1.0 (2018-01-30)

  • Initial Release