Metadata-Version: 2.1
Name: azure-eventhub
Version: 5.0.1
Summary: Microsoft Azure Event Hubs Client Library for Python
Home-page: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub
Author: Microsoft Corporation
Author-email: azpysdkhelp@microsoft.com
License: MIT License
Description: # Azure Event Hubs client library for Python
        
        Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream
        them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected
        devices and applications. Once Event Hubs has collected the data, you can retrieve, transform, and store it by using
        any real-time analytics provider or with batching/storage adapters. If you would like to know more about Azure Event Hubs,
        you may wish to review: [What is Event Hubs](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about)?
        
        The Azure Event Hubs client library allows for publishing and consuming of Azure Event Hubs events and may be used to:
        
        - Emit telemetry about your application for business intelligence and diagnostic purposes.
        - Publish facts about the state of your application which interested parties may observe and use as a trigger for taking action.
        - Observe interesting operations and interactions happening within your business or other ecosystem, allowing loosely coupled systems to interact without the need to bind them together.
        - Receive events from one or more publishers, transform them to better meet the needs of your ecosystem, then publish the transformed events to a new stream for consumers to observe.
        
        [Source code](https://github.com/Azure/azure-sdk-for-python/tree/93b121d268aa2913e6b499ad1c1928793c38ec77/sdk/eventhub/azure-eventhub) | [Package (PyPi)](https://pypi.org/project/azure-eventhub/5.0.1) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.0.1/azure.eventhub.html) | [Product documentation](https://docs.microsoft.com/en-us/azure/event-hubs/)
        
        ## Getting started
        
        ### Prerequisites
        
        - Python 2.7, 3.5.3 or later.
        - **Microsoft Azure Subscription:**  To use Azure services, including Azure Event Hubs, you'll need a subscription.
        If you do not have an existing Azure account, you may sign up for a free trial or use your MSDN subscriber benefits when you [create an account](https://account.windowsazure.com/Home/Index).
        
        - **Event Hubs namespace with an Event Hub:** To interact with Azure Event Hubs, you'll also need to have a namespace and Event Hub  available.
        If you are not familiar with creating Azure resources, you may wish to follow the step-by-step guide
        for [creating an Event Hub using the Azure portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create).
        There, you can also find detailed instructions for using the Azure CLI, Azure PowerShell, or Azure Resource Manager (ARM) templates to create an Event Hub.
        
        ### Install the package
        
        Install the Azure Event Hubs client library for Python with pip:
        
        ```
        $ pip install azure-eventhub
        ```
        
        ### Authenticate the client
        
        Interaction with Event Hubs starts with an instance of EventHubConsumerClient or EventHubProducerClient class. You need either the host name, SAS/AAD credential and event hub name or a connection string to instantiate the client object.
        
        **Create client from connection string:**
        
        For the Event Hubs client library to interact with an Event Hub, the easiest means is to use a connection string, which is created automatically when creating an Event Hubs namespace.
        If you aren't familiar with shared access policies in Azure, you may wish to follow the step-by-step guide to [get an Event Hubs connection string](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string).
        
        
        ```python
        from azure.eventhub import EventHubConsumerClient, EventHubProducerClient
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        consumer_group = '<< CONSUMER GROUP >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        producer_client = EventHubProducerClient.from_connection_string(connection_str, eventhub_name=eventhub_name)
        consumer_client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name)
        
        ```
        
        - The `from_connection_string` method takes the connection string of the form
        `Endpoint=sb://<yournamespace>.servicebus.windows.net/;SharedAccessKeyName=<yoursharedaccesskeyname>;SharedAccessKey=<yoursharedaccesskey>` and
        entity name to your Event Hub instance. You can get the connection string from the [Azure portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal).
        
        **Create client using the azure-identity library:**
        
        ```python
        from azure.eventhub import EventHubConsumerClient
        from azure.identity import DefaultAzureCredential
        
        credential = DefaultAzureCredential()
        
        fully_qualified_namespace = '<< HOSTNAME OF THE EVENT HUB >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        consumer_group = '<< CONSUMER GROUP >>'
        consumer_client = EventHubConsumerClient(fully_qualified_namespace, eventhub_name, consumer_group, credential)
        
        ```
        
        - This constructor takes the host name and entity name of your Event Hub instance and credential that implements the
        [TokenCredential](https://github.com/Azure/azure-sdk-for-python/tree/93b121d268aa2913e6b499ad1c1928793c38ec77/sdk/core/azure-core/azure/core/credentials.py)
        protocol. There are implementations of the `TokenCredential` protocol available in the
        [azure-identity package](https://pypi.org/project/azure-identity/). The host name is of the format `<yournamespace.servicebus.windows.net>`.
        - When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the
        Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs,
        please refer to [the associated documentation](https://docs.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory).
        
        ## Key concepts
        
        - An **EventHubProducerClient** is a source of telemetry data, diagnostics information, usage logs, or other log data,
        as part of an embedded device solution, a mobile device application, a game title running on a console or other device,
        some client or server based business solution, or a web site.
        
        - An **EventHubConsumerClient** picks up such information from the Event Hub and processes it. Processing may involve aggregation,
        complex computation, and filtering. Processing may also involve distribution or storage of the information in a raw or transformed fashion.
        Event Hub consumers are often robust and high-scale platform infrastructure parts with built-in analytics capabilities,
        like Azure Stream Analytics, Apache Spark, or Apache Storm.
        
        - A **partition** is an ordered sequence of events that is held in an Event Hub. Azure Event Hubs provides message streaming
        through a partitioned consumer pattern in which each consumer only reads a specific subset, or partition, of the message stream.
        As newer events arrive, they are added to the end of this sequence. The number of partitions is specified at the time anEvent Hub is created and cannot be changed.
        
        - A **consumer group** is a view of an entire Event Hub. Consumer groups enable multiple consuming applications to each
        have a separate view of the event stream, and to read the stream independently at their own pace and from their own position.
        There can be at most 5 concurrent readers on a partition per consumer group; however it is recommended that there is only
        one active consumer for a given partition and consumer group pairing. Each active reader receives all of the events from
        its partition; if there are multiple readers on the same partition, then they will receive duplicate events.
        
        For more concepts and deeper discussion, see: [Event Hubs Features](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features).
        Also, the concepts for AMQP are well documented in [OASIS Advanced Messaging Queuing Protocol (AMQP) Version 1.0](http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0-os.html).
        
        ## Examples
        
        The following sections provide several code snippets covering some of the most common Event Hubs tasks, including:
        
        - [Inspect an Event Hub](#inspect-an-event-hub)
        - [Publish events to an Event Hub](#publish-events-to-an-event-hub)
        - [Consume events from an Event Hub](#consume-events-from-an-event-hub)
        - [Publish events to an Event Hub asynchronously](#publish-events-to-an-event-hub-asynchronously)
        - [Consume events from an Event Hub asynchronously](#consume-events-from-an-event-hub-asynchronously)
        - [Consume events and save checkpoints using a checkpoint store](#consume-events-and-save-checkpoints-using-a-checkpoint-store)
        - [Use EventHubConsumerClient to work with IoT Hub](#use-eventhubconsumerclient-to-work-with-iot-hub)
        
        ### Inspect an Event Hub
        
        Get the partition ids of an Event Hub.
        
        ```python
        from azure.eventhub import EventHubConsumerClient
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        consumer_group = '<< CONSUMER GROUP >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name)
        partition_ids = client.get_partition_ids()
        ```
        
        ### Publish events to an Event Hub
        
        Publish events to an Event Hub.
        Use the `create_batch` method on `EventHubProducerClient` to create an `EventDataBatch` object which can then be sent using the `send_batch` method.
        Events may be added to the `EventDataBatch` using the `add` method until the maximum batch size limit in bytes has been reached.
        ```python
        from azure.eventhub import EventHubProducerClient, EventData
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        client = EventHubProducerClient.from_connection_string(connection_str, eventhub_name=eventhub_name)
        
        event_data_batch = client.create_batch()
        can_add = True
        while can_add:
            try:
                event_data_batch.add(EventData('Message inside EventBatchData'))
            except ValueError:
                can_add = False  # EventDataBatch object reaches max_size.
        
        with client:
            client.send_batch(event_data_batch)
        ```
        
        ### Consume events from an Event Hub
        
        Consume events from an Event Hub.
        
        ```python
        import logging
        from azure.eventhub import EventHubConsumerClient
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        consumer_group = '<< CONSUMER GROUP >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name)
        
        logger = logging.getLogger("azure.eventhub")
        logging.basicConfig(level=logging.INFO)
        
        def on_event(partition_context, event):
            logger.info("Received event from partition {}".format(partition_context.partition_id))
            partition_context.update_checkpoint(event)
        
        with client:
            client.receive(
                on_event=on_event, 
                starting_position="-1",  # "-1" is from the beginning of the partition.
            )
            # receive events from specified partition:
            # client.receive(on_event=on_event, partition_id='0')
        ```
        
        ### Publish events to an Event Hub asynchronously
        
        Publish events to an Event Hub asynchronously
        Use the `create_batch` method on `EventHubProcuer` to create an `EventDataBatch` object which can then be sent using the `send_batch` method.
        Events may be added to the `EventDataBatch` using the `add` method until the maximum batch size limit in bytes has been reached.
        ```python
        import asyncio
        from azure.eventhub.aio import EventHubProducerClient  # The package name suffixed with ".aio" for async
        from azure.eventhub import EventData
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        consumer_group = '<< CONSUMER GROUP >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        
        async def create_batch(client):
            event_data_batch = await client.create_batch()
            can_add = True
            while can_add:
                try:
                    event_data_batch.add(EventData('Message inside EventBatchData'))
                except ValueError:
                    can_add = False  # EventDataBatch object reaches max_size.
            return event_data_batch
        
        async def send():
            client = EventHubProducerClient.from_connection_string(connection_str, eventhub_name=eventhub_name)
            batch_data = await create_batch(client)
            async with client:
                await client.send_batch(batch_data)
        
        if __name__ == '__main__':
            loop = asyncio.get_event_loop()
            loop.run_until_complete(send())
        ```
        
        ### Consume events from an Event Hub asynchronously
        
        Consume events asynchronously from an EventHub.
        
        ```python
        import logging
        import asyncio
        from azure.eventhub.aio import EventHubConsumerClient
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        consumer_group = '<< CONSUMER GROUP >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        
        logger = logging.getLogger("azure.eventhub")
        logging.basicConfig(level=logging.INFO)
        
        async def on_event(partition_context, event):
            logger.info("Received event from partition {}".format(partition_context.partition_id))
            await partition_context.update_checkpoint(event)
        
        async def receive():
            client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name)
            async with client:
                await client.receive(
                    on_event=on_event,
                    starting_position="-1",  # "-1" is from the beginning of the partition.
                )
                # receive events from specified partition:
                # await client.receive(on_event=on_event, partition_id='0')
        
        if __name__ == '__main__':
            loop = asyncio.get_event_loop()
            loop.run_until_complete(receive())
        ```
        
        ### Consume events and save checkpoints using a checkpoint store
        
        `EventHubConsumerClient` is a high level construct which allows you to receive events from multiple partitions at once
        and load balance with other consumers using the same Event Hub and consumer group.
        
        This also allows the user to track progress when events are processed using checkpoints.
        
        A checkpoint is meant to represent the last successfully processed event by the user from a particular partition of
        a consumer group in an Event Hub instance. The `EventHubConsumerClient` uses an instance of `CheckpointStore` to update checkpoints
        and to store the relevant information required by the load balancing algorithm.
        
        Search pypi with the prefix `azure-eventhub-checkpointstore` to
        find packages that support this and use the `CheckpointStore` implementation from one such package. Please note that both sync and async libraries are provided.
        
        In the below example, we create an instance of `EventHubConsumerClient` and use a `BlobCheckpointStore`. You need
        to [create an Azure Storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal)
        and a [Blob Container](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container) to run the code.
        
        [Azure Blob Storage Checkpoint Store Async](https://github.com/Azure/azure-sdk-for-python/tree/93b121d268aa2913e6b499ad1c1928793c38ec77/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio)
        and [Azure Blob Storage Checkpoint Store Sync](https://github.com/Azure/azure-sdk-for-python/tree/93b121d268aa2913e6b499ad1c1928793c38ec77/sdk/eventhub/azure-eventhub-checkpointstoreblob)
        are one of the `CheckpointStore` implementations we provide that applies Azure Blob Storage as the persistent store.
        
        
        ```python
        import asyncio
        
        from azure.eventhub.aio import EventHubConsumerClient
        from azure.eventhub.extensions.checkpointstoreblobaio import BlobCheckpointStore
        
        connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
        consumer_group = '<< CONSUMER GROUP >>'
        eventhub_name = '<< NAME OF THE EVENT HUB >>'
        storage_connection_str = '<< CONNECTION STRING FOR THE STORAGE >>'
        container_name = '<<NAME OF THE BLOB CONTAINER>>'
        
        async def on_event(partition_context, event):
            # do something
            await partition_context.update_checkpoint(event)  # Or update_checkpoint every N events for better performance.
        
        async def receive(client):
            await client.receive(
                on_event=on_event,
                starting_position="-1",  # "-1" is from the beginning of the partition.
            )
        
        async def main():
            checkpoint_store = BlobCheckpointStore.from_connection_string(storage_connection_str, container_name)
            client = EventHubConsumerClient.from_connection_string(
                connection_str,
                consumer_group,
                eventhub_name=eventhub_name,
                checkpoint_store=checkpoint_store,  # For load balancing and checkpoint. Leave None for no load balancing
            )
            async with client:
                await receive(client)
        
        if __name__ == '__main__':
            loop = asyncio.get_event_loop()
            loop.run_until_complete(main())
        ```
        
        ### Use EventHubConsumerClient to work with IoT Hub
        
        You can use `EventHubConsumerClient` to work with IoT Hub as well. This is useful for receiving telemetry data of IoT Hub from the
        linked EventHub. The associated connection string will not have send claims, hence sending events is not possible.
        
        - Please notice that the connection string needs to be for an
          [Event Hub-compatible endpoint](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin)
          e.g. "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name"
        
        ```python
        from azure.eventhub import EventHubConsumerClient
        
        connection_str = 'Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name'
        consumer_group = '<< CONSUMER GROUP >>'
        client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group)
        
        partition_ids = client.get_partition_ids()
        ```
        
        ## Troubleshooting
        
        ### General
        
        The Event Hubs APIs generate the following exceptions in azure.eventhub.exceptions
        
        - **AuthenticationError:** Failed to authenticate because of wrong address, SAS policy/key pair, SAS token or azure identity.
        - **ConnectError:** Failed to connect to the EventHubs. The AuthenticationError is a type of ConnectError.
        - **ConnectionLostError:** Lose connection after a connection has been built.
        - **EventDataError:** The EventData to be sent fails data validation. For instance, this error is raised if you try to send an EventData that is already sent.
        - **EventDataSendError:** The Eventhubs service responds with an error when an EventData is sent.
        - **OperationTimeoutError:** EventHubConsumer.send() times out.
        - **EventHubError:** All other Eventhubs related errors. It is also the root error class of all the errors described above.
        
        ### Logging
        
        - Enable `azure.eventhub` logger to collect traces from the library.
        - Enable `uamqp` logger to collect traces from the underlying uAMQP library.
        - Enable AMQP frame level trace by setting `logging_enable=True` when creating the client.
        
        ## Next steps
        
        ### More sample code
        
        Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/93b121d268aa2913e6b499ad1c1928793c38ec77/sdk/eventhub/azure-eventhub/samples) directory for detailed examples of how to use this library to send and receive events to/from Event Hubs.
        
        ### Documentation
        
        Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.0.1/azure.eventhub.html).
        
        ### Provide Feedback
        
        If you encounter any bugs or have suggestions, please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-python/issues) section of the project.
        
        ## Contributing
        
        This project welcomes contributions and suggestions.  Most contributions require you to agree to a
        Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
        
        When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the
        PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
        
        This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
        For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
        
        ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/eventhub/azure-eventhub/README.png)
        
        
        # Release History
        
        ## 5.0.1 (2020-03-09)
        
        **Bug fixes**
        
        - Fixed a bug that swallowed errors when receiving events with `azure.eventhub.EventHubConsumerClient`  #9660
        - Fixed a bug that caused `get_eventhub_properties`, `get_partition_ids`, and `get_partition_properties` to raise
        an error on Azure Stack #9920 
        
        ## 5.0.0 (2020-01-13)
        
        **Breaking changes**
        
        - `EventData`
            - Removed deprecated property `application_properties` and deprecated method `encode_message()`.
        - `EventHubConsumerClient`
            - `on_error` would be called when `EventHubConsumerClient` failed to claim ownership of partitions.
            - `on_partition_close` and `on_partition_initialize` would be called in the case of exceptions raised by `on_event` callback.
                -  `EventHubConsumerClient` would close and re-open the internal partition receiver in this case.
            - Default starting position from where `EventHubConsumerClient` should resume receiving after recovering from an error has been re-prioritized.
                - If there is checkpoint, it will resume from the checkpoint.
                - If there is no checkpoint but `starting_position` is provided, it will resume from `starting_posititon`.
                - If there is no checkpoint or `starting_position`, it will resume from the latest position.
        - `PartitionContext`
            - `update_checkpoint` would do in-memory checkpoint instead of doing nothing when checkpoint store is not explicitly provided.
                - The in-memory checkpoints would be used for `EventHubConsumerClient` receiving recovering.
        - `get_partition_ids`, `get_partition_properties`, `get_eventhub_properties` would raise error in the case of service returning an error status code.
            - `AuthenticationError` would be raised when service returning error code 401.
            - `ConnectError` would be raised when service returning error code 404.
            - `EventHubError` would be raised when service returning other error codes.
        
        ## 5.0.0b6 (2019-12-03)
        
        **Breaking changes**
        
        - All exceptions should now be imported from `azure.eventhub.exceptions`.
        - Introduced separate `EventHubSharedKeyCredential` objects for synchronous and asynchronous operations.
          For async, import the credentials object from the `azure.eventhub.aio` namespace.
        - `EventData`
            - Renamed property `application_properties` to `properties`.
            - `EventData` no longer has attribute `last_enqueued_event_properties` - use this on `PartitionContext` instead.
        - `EvenDataBatch`
            - `EventDataBatch.try_add` has been renamed to `EventDataBatch.add`.
            - Renamed property `size` to `size_in_bytes`.
            - Renamed attribute `max_size` to `max_size_in_bytes`.
        - `EventHubConsumerClient` and `EventHubProducerClient`
            - Renamed method `get_properties` to `get_eventhub_properties`.
            - Renamed parameters in constructor: `host` to `fully_qualified_namespace`, `event_hub_path` to `eventhub_name`.
            - Renamed parameters in `get_partition_properties`: `partition` to `partition_id`.
            - Renamed parameter `consumer_group_name` to `consumer_group` and moved that parameter from `receive` method to the constructor of `EventHubConsumerClient`.
            - Renamed parameter `initial_event_position` to `starting_position` on the `receive` method of `EventHubConsumerClient`.
            - Renamed parameter `event_hub_path` to `eventhub_name` in constructor and `from_connection_string` method of the client object.
            - `EventHubProducerClient.send` has been renamed to `send_batch` which will only accept `EventDataBatch` object as input.
            - `EventHubProducerClient.create_batch` now also takes the `partition_id` and `partition_key` as optional parameters (which are no longer specified at send).
        - Renamed module `PartitionManager` to `CheckpointStore`.
        - Receive event callback parameter has been renamed to `on_event` and now operates on a single event rather than a list of events.
        - Removed class `EventPostition`.
            - The `starting_position` parameter of the `receive` method accepts offset(`str`), sequence number(`int`), datetime (`datetime.datetime`) or `dict` of these types.
            - The `starting_position_inclusive` parameter of the `receive` method accepts `bool` or `dict` indicating whether the given event position is inclusive or not.
        - `PartitionContext` no longer has attribute `owner_id`.
        - `PartitionContext` now has attribute `last_enqueued_event_properties` which is populated if `track_last_enqueued_event_properties` is set to `True` in the `receive` method.
        
        
        **New features**
        
        - Added new parameter `idle_timeout` in construct and `from_connection_string` to `EventHubConsumerClient` and `EventHubProducerClient`
        after which the underlying connection will close if there is no further activity.
        
        ## 5.0.0b5 (2019-11-04)
        
        **Breaking changes**
        
        - `EventHubClient`, `EventHubConsumer` and `EventHubProducer` has been removed. Use `EventHubProducerClient` and `EventHubConsumerClient` instead.
            - Construction of both objects is the same as it was for the previous client.
        - Introduced `EventHubProducerClient` as substitution for`EventHubProducer`.
            - `EventHubProducerClient` supports sending events to different partitions.
        - Introduced `EventHubConsumerClient` as substitution for `EventHubConsumer`.
            - `EventHubConsumerClient` supports receiving events from single/all partitions.
            - There are no longer methods which directly return `EventData`, all receiving is done via callback method: `on_events`.
        - `EventHubConsumerClient` has taken on the responsibility of `EventProcessor`.
            - `EventHubConsumerClient` now accepts `PartitionManager` to do load-balancing and checkpoint.
        - Replaced `PartitionProcessor`by four independent callback methods accepted by the `receive` method on `EventHubConsumerClient`.
            - `on_events(partition_context, events)` called when events are received.
            - `on_error(partition_context, exception` called when errors occur.
            - `on_partition_initialize(partition_context)` called when a partition consumer is opened.
            - `on_partition_close(partition_context, reason)` called when a partition consumer is closed.
        - Some modules and classes that were importable from several different places have been removed:
            - `azure.eventhub.common` has been removed. Import from `azure.eventhub` instead.
            - `azure.eventhub.client_abstract` has been removed. Use `azure.eventhub.EventHubProducerClient` or `azure.eventhub.EventHubConsumerClient` instead.
            - `azure.eventhub.client` has been removed. Use `azure.eventhub.EventHubProducerClient` or `azure.eventhub.EventHubConsumerClient` instead.
            - `azure.eventhub.producer` has been removed. Use `azure.eventhub.EventHubProducerClient` instead.
            - `azure.eventhub.consumer` has been removed. Use `azure.eventhub.EventHubConsumerClient` instead.
            - `azure.eventhub.aio.client_async` has been removed. Use `azure.eventhub.aio.EventHubProducerClient` or `azure.eventhub.aio.EventHubConsumerClient` instead.
            - `azure.eventhub.aio.producer_async` has been removed. Use `azure.eventhub.aio.EventHubProducerClient` instead.
            - `azure.eventhub.aio.consumer_async` has been removed. Use `azure.eventhub.aio.EventHubConsumerClient` instead.
            - `azure.eventhub.aio.event_processor.event_processor` has been removed. Use `azure.eventhub.aio.EventHubConsumerClient` instead.
            - `azure.eventhub.aio.event_processor.partition_processor` has been removed. Use callback methods instead.
            - `azure.eventhub.aio.event_processor.partition_manager` has been removed. Import from `azure.eventhub.aio` instead.
            - `azure.eventhub.aio.event_processor.partition_context` has been removed. Import from `azure.eventhub.aio` instead.
            - `azure.eventhub.aio.event_processor.sample_partition_manager` has been removed.
        
        **Bug fixes**
        
        - Fixed bug in user-agent string not being parsed.
        
        ## 5.0.0b4 (2019-10-08)
        
        **New features**
        
        - Added support for tracing (issue #7153).
        - Added the capability of tracking last enqueued event properties of the partition to `EventHubConsumer` .
            - Added new boolean type parameter`track_last_enqueued_event_properties` in method `EventHubClient.create_consumer()`.
            - Added new property `last_enqueued_event_properties` of `EventHubConsumer` which contains sequence_number, offset, enqueued_time and retrieval_time information.
            - By default the capability is disabled as it will cost extra bandwidth for transferring more information if turned on.
        
        **Breaking changes**
        
        - Removed support for IoT Hub direct connection.
            - [EventHubs compatible connection string](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin) of an IotHub can be used to create `EventHubClient` and read properties or events from an IoT Hub.
        - Removed support for sending EventData to IoT Hub.
        - Removed parameter `exception` in method `close()` of `EventHubConsumer` and `EventHubProcuer`.
        - Updated uAMQP dependency to 1.2.3.
        
        ## 5.0.0b3 (2019-09-10)
        
        **New features**
        
        - Added support for automatic load balancing among multiple `EventProcessor`.
        - Added `BlobPartitionManager` which implements `PartitionManager`.
            - Azure Blob Storage is applied for storing data used by `EventProcessor`.
            - Packaged separately as a plug-in to `EventProcessor`.
            - For details, please refer to [Azure Blob Storage Partition Manager](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio).
        - Added property `system_properties` on `EventData`.
        
        **Breaking changes**
        
        - Removed constructor method of `PartitionProcessor`. For initialization please implement the method `initialize`.
        - Replaced `CheckpointManager` by `PartitionContext`.
            - `PartitionContext` has partition context information and method `update_checkpoint`.
        - Updated all methods of `PartitionProcessor` to include `PartitionContext` as part of the arguments.
        - Updated accessibility of class members in `EventHub/EventHubConsumer/EventHubProducer`to be private.
        - Moved `azure.eventhub.eventprocessor` under `aio` package, which now becomes `azure.eventhub.aio.eventprocessor`.
        
        ## 5.0.0b2 (2019-08-06)
        
        **New features**
        
        - Added method `create_batch` on the `EventHubProducer` to create an `EventDataBatch` that can then be used to add events until the maximum size is reached.
            - This batch object can then be used in the `send()` method to send all the added events to Event Hubs.
            - This allows publishers to build batches without the possibility of encountering the error around the message size exceeding the supported limit when sending events.
            - It also allows publishers with bandwidth concerns to control the size of each batch published.
        - Added new configuration parameters for exponential delay between retry operations.
            - `retry_total`: The total number of attempts to redo the failed operation.
            - `backoff_factor`: The delay time factor.
            - `backoff_max`: The maximum delay time in total.
        - Added support for context manager on `EventHubClient`.
        - Added new error type `OperationTimeoutError` for send operation.
        - Introduced a new class `EventProcessor` which replaces the older concept of [Event Processor Host](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-event-processor-host). This early preview is intended to allow users to test the new design using a single instance of `EventProcessor`. The ability to checkpoints to a durable store will be added in future updates.
            - `EventProcessor`: EventProcessor creates and runs consumers for all partitions of the eventhub.
            - `PartitionManager`: PartitionManager defines the interface for getting/claiming ownerships of partitions and updating checkpoints.
            - `PartitionProcessor`: PartitionProcessor defines the interface for processing events.
            - `CheckpointManager`: CheckpointManager takes responsibility for updating checkpoints during events processing.
        
        **Breaking changes**
        
        - `EventProcessorHost` was replaced by `EventProcessor`, please read the new features for details.
        - Replaced `max_retries` configuration parameter of the EventHubClient with `retry_total`.
        
        
        ## 5.0.0b1 (2019-06-25)
        
        Version 5.0.0b1 is a preview of our efforts to create a client library that is user friendly and idiomatic to the Python ecosystem. The reasons for most of the changes in this update can be found in the [Azure SDK Design Guidelines for Python](https://azuresdkspecs.z5.web.core.windows.net/PythonSpec.html). For more information, please visit https://aka.ms/azure-sdk-preview1-python.
        
        **New features**
        
        - Added new configuration parameters for creating EventHubClient.
          - `credential`: The credential object used for authentication which implements `TokenCredential` interface of getting tokens.
          - `transport_type`: The type of transport protocol that will be used for communicating with the Event Hubs service.
          - `max_retries`: The max number of attempts to redo the failed operation when an error happened.
          - for detailed information about the configuration parameters, please read the reference documentation.
        - Added new methods `get_partition_properties` and `get_partition_ids` to EventHubClient.
        - Added support for http proxy.
        - Added support for authentication using azure-identity credential.
        - Added support for transport using AMQP over WebSocket.
        
        **Breaking changes**
        
        - New error hierarchy
          - `azure.error.EventHubError`
          - `azure.error.ConnectionLostError`
          - `azure.error.ConnectError`
          - `azure.error.AuthenticationError`
          - `azure.error.EventDataError`
          - `azure.error.EventDataSendError`
        - Renamed Sender/Receiver to EventHubProducer/EventHubConsumer.
          - Renamed `add_sender` to `create_producer` and `add_receiver` to `create_consumer` in EventHubClient.
          - EventHubConsumer is now iterable.
        - Rename class azure.eventhub.Offset to azure.eventhub.EventPosition.
        - Rename method `get_eventhub_info` to `get_properties` of EventHubClient.
        - Reorganized connection management, EventHubClient is no longer responsible for opening/closing EventHubProducer/EventHubConsumer.
          - Each EventHubProducer/EventHubConsumer is responsible for its own connection management.
          - Added support for context manager on EventHubProducer and EventHubConsumer.
        - Reorganized async APIs into "azure.eventhub.aio" namespace and rename to drop the "_async" suffix.
        - Updated uAMQP dependency to 1.2.
        
        ## 1.3.1 (2019-02-28)
        
        **BugFixes**
        
        - Fixed bug where datetime offset filter was using a local timestamp rather than UTC.
        - Fixed stackoverflow error in continuous connection reconnect attempts.
        
        
        ## 1.3.0 (2019-01-29)
        
        **BugFixes**
        
        - Added support for auto reconnect on token expiration and other auth errors (issue #89).
        
        **Features**
        
        - Added ability to create ServiceBusClient from an existing SAS auth token, including
          providing a function to auto-renew that token on expiry.
        - Added support for storing a custom EPH context value in checkpoint (PR #84, thanks @konstantinmiller)
        
        
        ## 1.2.0 (2018-11-29)
        
        - Support for Python 2.7 in azure.eventhub module (azure.eventprocessorhost will not support Python 2.7).
        - Parse EventData.enqueued_time as a UTC timestamp (issue #72, thanks @vjrantal)
        
        
        ## 1.1.1 (2018-10-03)
        
        - Fixed bug in Azure namespace package.
        
        
        ## 1.1.0 (2018-09-21)
        
        - Changes to `AzureStorageCheckpointLeaseManager` parameters to support other connection options (issue #61):
          - The `storage_account_name`, `storage_account_key` and `lease_container_name` arguments are now optional keyword arguments.
          - Added a `sas_token` argument that must be specified with `storage_account_name` in place of `storage_account_key`.
          - Added an `endpoint_suffix` argument to support storage endpoints in National Clouds.
          - Added a `connection_string` argument that, if specified, overrides all other endpoint arguments.
          - The `lease_container_name` argument now defaults to `"eph-leases"` if not specified.
        
        - Fix for clients failing to start if run called multipled times (issue #64).
        - Added convenience methods `body_as_str` and `body_as_json` to EventData object for easier processing of message data.
        
        
        ## 1.0.0 (2018-08-22)
        
        - API stable.
        - Renamed internal `_async` module to `async_ops` for docs generation.
        - Added optional `auth_timeout` parameter to `EventHubClient` and `EventHubClientAsync` to configure how long to allow for token
          negotiation to complete. Default is 60 seconds.
        - Added optional `send_timeout` parameter to `EventHubClient.add_sender` and `EventHubClientAsync.add_async_sender` to determine the
          timeout for Events to be successfully sent. Default value is 60 seconds.
        - Reformatted logging for performance.
        
        
        ## 0.2.0 (2018-08-06)
        
        - Stability improvements for EPH.
        - Updated uAMQP version.
        - Added new configuration options for Sender and Receiver; `keep_alive` and `auto_reconnect`.
          These flags have been added to the following:
        
          - `EventHubClient.add_receiver`
          - `EventHubClient.add_sender`
          - `EventHubClientAsync.add_async_receiver`
          - `EventHubClientAsync.add_async_sender`
          - `EPHOptions.keey_alive_interval`
          - `EPHOptions.auto_reconnect_on_error`
        
        
        ## 0.2.0rc2 (2018-07-29)
        
        - **Breaking change** `EventData.offset` will now return an object of type `~uamqp.common.Offset` rather than str.
          The original string value can be retrieved from `~uamqp.common.Offset.value`.
        - Each sender/receiver will now run in its own independent connection.
        - Updated uAMQP dependency to 0.2.0
        - Fixed issue with IoTHub clients not being able to retrieve partition information.
        - Added support for HTTP proxy settings to both EventHubClient and EPH.
        - Added error handling policy to automatically reconnect on retryable error.
        - Added keep-alive thread for maintaining an unused connection.
        
        
        ## 0.2.0rc1 (2018-07-06)
        
        - **Breaking change** Restructured library to support Python 3.7. Submodule `async` has been renamed and all classes from
          this module can now be imported from azure.eventhub directly.
        - **Breaking change** Removed optional `callback` argument from `Receiver.receive` and `AsyncReceiver.receive`.
        - **Breaking change** `EventData.properties` has been renamed to `EventData.application_properties`.
          This removes the potential for messages to be processed via callback for not yet returned
          in the batch.
        - Updated uAMQP dependency to v0.1.0
        - Added support for constructing IoTHub connections.
        - Fixed memory leak in receive operations.
        - Dropped Python 2.7 wheel support.
        
        
        ## 0.2.0b2 (2018-05-29)
        
        - Added `namespace_suffix` to EventHubConfig() to support national clouds.
        - Added `device_id` attribute to EventData to support IoT Hub use cases.
        - Added message header to workaround service bug for PartitionKey support.
        - Updated uAMQP dependency to vRC1.
        
        
        ## 0.2.0b1 (2018-04-20)
        
        - Updated uAMQP to latest version.
        - Further testing and minor bug fixes.
        
        
        ## 0.2.0a2 (2018-04-02)
        
        - Updated uAQMP dependency.
        
        
        ## 0.2.0a1 (unreleased)
        
        - Swapped out Proton dependency for uAMQP.
        
        ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/eventhub/azure-eventhub/HISTORY.png)
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
