Skip to content

Commit aac8cd3

Browse files
authored
Docs.MS Release Updates for azure-eventhub (MicrosoftDocs#1256)
Update docs metadata and targeting for release of azure-eventhub
1 parent 71d72c7 commit aac8cd3

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs-ref-services/latest/eventhub-readme.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ title: Azure Event Hubs client library for Python
33
keywords: Azure, python, SDK, API, azure-eventhub, eventhubseventhubs
44
author: maggiepint
55
ms.author: magpint
6-
ms.date: 02/09/2021
6+
ms.date: 03/09/2021
77
ms.topic: article
88
ms.prod: azure
99
ms.technology: azure
1010
ms.devlang: python
1111
ms.service: eventhubseventhubs
1212
---
1313

14-
# Azure Event Hubs client library for Python - Version 5.3.0
14+
# Azure Event Hubs client library for Python - Version 5.3.1
1515

1616

1717
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
2727
- 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.
2828
- 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.
2929

30-
[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)
30+
[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)
3131
## Getting started
3232

3333
### Prerequisites
@@ -53,7 +53,7 @@ $ pip install azure-eventhub
5353

5454
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.
5555

56-
**[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)**
56+
**[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)**
5757

5858
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.
5959
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
6262
`Endpoint=sb://<yournamespace>.servicebus.windows.net/;SharedAccessKeyName=<yoursharedaccesskeyname>;SharedAccessKey=<yoursharedaccesskey>` and
6363
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).
6464

65-
**[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)**
65+
**[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)**
6666

6767
Alternately, one can use a Credential object to authenticate via AAD with the azure-identity package.
6868

6969
- 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
70-
[TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.0/sdk/core/azure-core/azure/core/credentials.py)
70+
[TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.3.1/sdk/core/azure-core/azure/core/credentials.py)
7171
protocol. There are implementations of the `TokenCredential` protocol available in the
7272
[azure-identity package](https://pypi.org/project/azure-identity/). The host name is of the format `<yournamespace.servicebus.windows.net>`.
7373
- 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
337337
to [create an Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal)
338338
and a [Blob Container](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container) to run the code.
339339

340-
[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)
341-
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)
340+
[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)
341+
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)
342342
are one of the `CheckpointStore` implementations we provide that applies Azure Blob Storage as the persistent store.
343343

344344

@@ -400,7 +400,7 @@ client = EventHubConsumerClient.from_connection_string(connection_str, consumer_
400400
partition_ids = client.get_partition_ids()
401401
```
402402
- Programmatically retrieve the built-in Event Hubs compatible endpoint.
403-
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).
403+
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).
404404

405405
## Troubleshooting
406406

@@ -426,11 +426,11 @@ The Event Hubs APIs generate the following exceptions in azure.eventhub.exceptio
426426

427427
### More sample code
428428

429-
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.
429+
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.
430430

431431
### Documentation
432432

433-
Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html).
433+
Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.3.1/azure.eventhub.html).
434434

435435
### Schema Registry and Avro Serializer
436436

@@ -462,8 +462,8 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.
462462

463463
[avro]: https://avro.apache.org/
464464
[schemaregistry_service]: https://aka.ms/schemaregistry
465-
[schemaregistry_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.0/sdk/schemaregistry/azure-schemaregistry
466-
[schemaregistry_avroserializer_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.0/sdk/schemaregistry/azure-schemaregistry-avroserializer
465+
[schemaregistry_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.1/sdk/schemaregistry/azure-schemaregistry
466+
[schemaregistry_avroserializer_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.3.1/sdk/schemaregistry/azure-schemaregistry-avroserializer
467467

468468
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/eventhub/azure-eventhub/README.png)
469469

0 commit comments

Comments
 (0)