From 4224bc6aa0641066cf0bb3af66e3629c7d8ab824 Mon Sep 17 00:00:00 2001 From: azure-sdk Date: Tue, 9 Mar 2021 19:49:31 +0000 Subject: [PATCH] Update docs metadata and targeting for release of azure-eventhub --- docs-ref-services/latest/eventhub-readme.md | 26 ++++++++++----------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs-ref-services/latest/eventhub-readme.md b/docs-ref-services/latest/eventhub-readme.md index 48fbd8e3b370..499878aac37b 100644 --- a/docs-ref-services/latest/eventhub-readme.md +++ b/docs-ref-services/latest/eventhub-readme.md @@ -3,7 +3,7 @@ title: Azure Event Hubs client library for Python keywords: Azure, python, SDK, API, azure-eventhub, eventhubseventhubs author: maggiepint ms.author: magpint -ms.date: 02/09/2021 +ms.date: 03/09/2021 ms.topic: article ms.prod: azure ms.technology: azure @@ -11,7 +11,7 @@ ms.devlang: python ms.service: eventhubseventhubs --- -# Azure Event Hubs client library for Python - Version 5.3.0 +# Azure Event Hubs client library for Python - Version 5.3.1 Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream @@ -27,7 +27,7 @@ The Azure Event Hubs client library allows for publishing and consuming of Azure - 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/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub/) | [Package (PyPi)](https://pypi.org/project/azure-eventhub/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html) | [Product documentation](https://docs.microsoft.com/azure/event-hubs/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub/samples) +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub/) | [Package (PyPi)](https://pypi.org/project/azure-eventhub/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.3.1/azure.eventhub.html) | [Product documentation](https://docs.microsoft.com/azure/event-hubs/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub/samples) ## Getting started ### Prerequisites @@ -53,7 +53,7 @@ $ pip install azure-eventhub 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:](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub/samples/sync_samples/connection_string_authentication.py)** +**[Create client from connection string:](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub/samples/sync_samples/connection_string_authentication.py)** 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/azure/event-hubs/event-hubs-get-connection-string). @@ -62,12 +62,12 @@ If you aren't familiar with shared access policies in Azure, you may wish to fol `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=` and entity name to your Event Hub instance. You can get the connection string from the [Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal). -**[Create client using the azure-identity library:](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub/samples/sync_samples/client_identity_authentication.py)** +**[Create client using the azure-identity library:](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub/samples/sync_samples/client_identity_authentication.py)** Alternately, one can use a Credential object to authenticate via AAD with the azure-identity package. - This constructor demonstrated in the sample linked above 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/blob/azure-eventhub_5.3.0/sdk/core/azure-core/azure/core/credentials.py) +[TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/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 ``. - To use the credential types provided by `azure-identity`, please install the package: @@ -337,8 +337,8 @@ In the below example, we create an instance of `EventHubConsumerClient` and use to [create an Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal) and a [Blob Container](https://docs.microsoft.com/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/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio) -and [Azure Blob Storage Checkpoint Store Sync](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub-checkpointstoreblob) +[Azure Blob Storage Checkpoint Store Async](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio) +and [Azure Blob Storage Checkpoint Store Sync](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub-checkpointstoreblob) are one of the `CheckpointStore` implementations we provide that applies Azure Blob Storage as the persistent store. @@ -400,7 +400,7 @@ client = EventHubConsumerClient.from_connection_string(connection_str, consumer_ partition_ids = client.get_partition_ids() ``` - Programmatically retrieve the built-in Event Hubs compatible endpoint. -Refer to [IoT Hub Connection String Sample](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub/samples/async_samples/iot_hub_connection_string_receive_async.py). +Refer to [IoT Hub Connection String Sample](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/eventhub/azure-eventhub/samples/async_samples/iot_hub_connection_string_receive_async.py). ## Troubleshooting @@ -426,11 +426,11 @@ The Event Hubs APIs generate the following exceptions in azure.eventhub.exceptio ### More sample code -Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.0/sdk/eventhub/azure-eventhub/samples) directory for detailed examples of how to use this library to send and receive events to/from Event Hubs. +Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/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/latest/azure.eventhub.html). +Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.3.1/azure.eventhub.html). ### Schema Registry and Avro Serializer @@ -462,8 +462,8 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft. [avro]: https://avro.apache.org/ [schemaregistry_service]: https://aka.ms/schemaregistry -[schemaregistry_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.0/sdk/schemaregistry/azure-schemaregistry -[schemaregistry_avroserializer_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.0/sdk/schemaregistry/azure-schemaregistry-avroserializer +[schemaregistry_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.1/sdk/schemaregistry/azure-schemaregistry +[schemaregistry_avroserializer_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.1/sdk/schemaregistry/azure-schemaregistry-avroserializer ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/eventhub/azure-eventhub/README.png)