Update docs metadata

azure-sdk · azure-sdk · commit c84a163b3106 · 2024-10-02T21:15:32.000Z
diff --git a/docs-ref-services/latest/eventhub-readme.md b/docs-ref-services/latest/eventhub-readme.md
@@ -1,12 +1,12 @@
 ---
 title: Azure Event Hubs client library for Python
-keywords: Azure, python, SDK, API, azure-eventhub, event-hubs
-ms.date: 06/11/2024
+keywords: Azure, python, SDK, API, azure-eventhub, azure-event-hubs
+ms.date: 10/02/2024
 ms.topic: reference
 ms.devlang: python
-ms.service: event-hubs
+ms.service: azure-event-hubs
 ---
-# Azure Event Hubs client library for Python - version 5.12.1 
+# Azure Event Hubs client library for Python - version 5.12.2 
 
 
 Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream
@@ -22,12 +22,12 @@ 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.12.1/sdk/eventhub/azure-eventhub/)
+[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.2/sdk/eventhub/azure-eventhub/)
 | [Package (PyPi)](https://pypi.org/project/azure-eventhub/)
 | [Package (Conda)](https://anaconda.org/microsoft/azure-eventhub/)
 | [API reference documentation][api_reference]
 | [Product documentation](/azure/event-hubs/)
-| [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.12.1/sdk/eventhub/azure-eventhub/samples)
+| [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.12.2/sdk/eventhub/azure-eventhub/samples)
 
 ## Getting started
 
@@ -54,7 +54,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.12.1/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.12.2/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](/azure/event-hubs/event-hubs-get-connection-string).
@@ -63,12 +63,12 @@ If you aren't familiar with shared access policies in Azure, you may wish to fol
 `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](/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.12.1/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.12.2/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.12.1/sdk/core/azure-core/azure/core/credentials.py)
+[TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.2/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>`.
 - To use the credential types provided by `azure-identity`, please install the package:
@@ -127,27 +127,25 @@ The following sections provide several code snippets covering some of the most c
 
 Get the partition ids of an Event Hub.
 
-<!-- SNIPPET:connection_string_authentication.connection_string_authentication -->
-
 ```python
 import os
 from azure.eventhub import EventHubConsumerClient
+from azure.identity import DefaultAzureCredential
 
-CONNECTION_STR = os.environ["EVENT_HUB_CONN_STR"]
+FULLY_QUALIFIED_NAMESPACE = os.environ["EVENT_HUB_HOSTNAME"]
 EVENTHUB_NAME = os.environ['EVENT_HUB_NAME']
 
-consumer_client = EventHubConsumerClient.from_connection_string(
-    conn_str=CONNECTION_STR,
+consumer_client = EventHubConsumerClient(
+    fully_qualified_namespace=FULLY_QUALIFIED_NAMESPACE,
     consumer_group='$Default',
     eventhub_name=EVENTHUB_NAME,
+    credential=DefaultAzureCredential(),
 )
 
 with consumer_client:
     pass # consumer_client is now ready to be used.
 ```
 
-<!-- END SNIPPET -->
-
 ### 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.
@@ -174,11 +172,17 @@ the `EventHubConsumerClient.receive` method will be of use as follows:
 ```python
 import logging
 from azure.eventhub import EventHubConsumerClient
+from azure.identity import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED 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)
+client = EventHubConsumerClient(
+    fully_qualified_namespace=fully_qualified_namespace,
+    eventhub_name=eventhub_name,
+    consumer_group=consumer_group,
+    credential=DefaultAzureCredential(),
+)
 
 logger = logging.getLogger("azure.eventhub")
 logging.basicConfig(level=logging.INFO)
@@ -204,11 +208,17 @@ triggers the callback on a batch of events, attempting to receive a number at a
 ```python
 import logging
 from azure.eventhub import EventHubConsumerClient
+from azure.identity import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED 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)
+client = EventHubConsumerClient(
+    fully_qualified_namespace=fully_qualified_namespace,
+    eventhub_name=eventhub_name,
+    consumer_group=consumer_group,
+    credential=DefaultAzureCredential(),
+)
 
 logger = logging.getLogger("azure.eventhub")
 logging.basicConfig(level=logging.INFO)
@@ -232,11 +242,11 @@ Use the `create_batch` method on `EventHubProducer` to create an `EventDataBatch
 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.aio import EventHubProducerClient   # The package name suffixed with ".aio" for async
 from azure.eventhub import EventData
+from azure.identity.aio import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
-consumer_group = '<< CONSUMER GROUP >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED NAMESPACE >>'
 eventhub_name = '<< NAME OF THE EVENT HUB >>'
 
 async def create_batch(client):
@@ -250,7 +260,11 @@ async def create_batch(client):
     return event_data_batch
 
 async def send():
-    client = EventHubProducerClient.from_connection_string(connection_str, eventhub_name=eventhub_name)
+    client = EventHubProducerClient(
+        fully_qualified_namespace=fully_qualified_namespace,
+        eventhub_name=eventhub_name,
+        credential=DefaultAzureCredential(),
+    )
     batch_data = await create_batch(client)
     async with client:
         await client.send_batch(batch_data)
@@ -269,8 +283,9 @@ aio, one would need the following:
 import logging
 import asyncio
 from azure.eventhub.aio import EventHubConsumerClient
+from azure.identity.aio import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED NAMESPACE >>'
 consumer_group = '<< CONSUMER GROUP >>'
 eventhub_name = '<< NAME OF THE EVENT HUB >>'
 
@@ -282,7 +297,12 @@ async def on_event(partition_context, event):
     await partition_context.update_checkpoint(event)
 
 async def receive():
-    client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name)
+    client = EventHubConsumerClient(
+        fully_qualified_namespace=fully_qualified_namespace,
+        eventhub_name=eventhub_name,
+        consumer_group=consumer_group,
+        credential=DefaultAzureCredential(),
+    )
     async with client:
         await client.receive(
             on_event=on_event,
@@ -305,8 +325,9 @@ the same within asyncio as follows:
 import logging
 import asyncio
 from azure.eventhub.aio import EventHubConsumerClient
+from azure.identity.aio import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED NAMESPACE >>'
 consumer_group = '<< CONSUMER GROUP >>'
 eventhub_name = '<< NAME OF THE EVENT HUB >>'
 
@@ -318,7 +339,12 @@ async def on_event_batch(partition_context, events):
     await partition_context.update_checkpoint()
 
 async def receive_batch():
-    client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name)
+    client = EventHubConsumerClient(
+        fully_qualified_namespace=fully_qualified_namespace,
+        eventhub_name=eventhub_name,
+        consumer_group=consumer_group,
+        credential=DefaultAzureCredential(),
+    )
     async with client:
         await client.receive_batch(
             on_event_batch=on_event_batch,
@@ -350,8 +376,8 @@ In the below example, we create an instance of `EventHubConsumerClient` and use
 to [create an Azure Storage account](/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal)
 and a [Blob Container](/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.12.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.12.1/sdk/eventhub/azure-eventhub-checkpointstoreblob)
+[Azure Blob Storage Checkpoint Store Async](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.2/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.12.2/sdk/eventhub/azure-eventhub-checkpointstoreblob)
 are one of the `CheckpointStore` implementations we provide that applies Azure Blob Storage as the persistent store.
 
 
@@ -360,11 +386,12 @@ import asyncio
 
 from azure.eventhub.aio import EventHubConsumerClient
 from azure.eventhub.extensions.checkpointstoreblobaio import BlobCheckpointStore
+from azure.identity.aio import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED NAMESPACE >>'
 consumer_group = '<< CONSUMER GROUP >>'
 eventhub_name = '<< NAME OF THE EVENT HUB >>'
-storage_connection_str = '<< CONNECTION STRING FOR THE STORAGE >>'
+blob_account_url = '<< STORAGE ACCOUNT URL >>'
 container_name = '<<NAME OF THE BLOB CONTAINER>>'
 
 async def on_event(partition_context, event):
@@ -378,11 +405,16 @@ async def receive(client):
     )
 
 async def main():
-    checkpoint_store = BlobCheckpointStore.from_connection_string(storage_connection_str, container_name)
-    client = EventHubConsumerClient.from_connection_string(
-        connection_str,
-        consumer_group,
+    checkpoint_store = BlobCheckpointStore(
+        blob_account_url=blob_account_url,
+        container_name=container_name,
+        credential=DefaultAzureCredential()
+    )
+    client = EventHubConsumerClient(
+        fully_qualified_namespace=fully_qualified_namespace,
         eventhub_name=eventhub_name,
+        credential=DefaultAzureCredential(),
+        consumer_group=consumer_group,
         checkpoint_store=checkpoint_store,  # For load balancing and checkpoint. Leave None for no load balancing
     )
     async with client:
@@ -413,11 +445,11 @@ 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.12.1/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.12.2/sdk/eventhub/azure-eventhub/samples/async_samples/iot_hub_connection_string_receive_async.py).
 
 ## Troubleshooting
 
-See the `azure-eventhub` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.1/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
+See the `azure-eventhub` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.2/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
 
 ### Logging
 
@@ -446,7 +478,7 @@ consumer = EventHubConsumerClient(..., logging_enable=True)
 
 ### More sample code
 
-Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.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.
+Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.12.2/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
 
@@ -473,16 +505,24 @@ $ pip install uamqp
 
 ```python
 from azure.eventhub import EventHubProducerClient, EventHubConsumerClient
+from azure.identity import DefaultAzureCredential
 
-connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>'
+fully_qualified_namespace = '<< EVENT HUBS FULLY QUALIFIED NAMESPACE >>'
 consumer_group = '<< CONSUMER GROUP >>'
 eventhub_name = '<< NAME OF THE EVENT HUB >>'
 
-client = EventHubProducerClient.from_connection_string(
-    connection_str, eventhub_name=eventhub_name, uamqp_transport=True
+client = EventHubProducerClient(
+    fully_qualified_namespace=fully_qualified_namespace,
+    eventhub_name=eventhub_name,
+    credential=DefaultAzureCredential(),
+    uamqp_transport=True
 )
-client = EventHubConsumerClient.from_connection_string(
-    connection_str, consumer_group, eventhub_name=eventhub_name, uamqp_transport=True
+client = EventHubConsumerClient(
+    fully_qualified_namespace=fully_qualified_namespace,
+    eventhub_name=eventhub_name,
+    credential=DefaultAzureCredential(),
+    consumer_group=consumer_group,
+    uamqp_transport=True
 )
 ```
 
@@ -515,8 +555,8 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.
 [avro]: https://avro.apache.org/
 [api_reference]: /python/api/overview/azure/eventhub-readme
 [schemaregistry_service]: https://aka.ms/schemaregistry
-[schemaregistry_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.12.1/sdk/schemaregistry/azure-schemaregistry
-[schemaregistry_avroencoder_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.12.1/sdk/schemaregistry/azure-schemaregistry-avroencoder
+[schemaregistry_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.12.2/sdk/schemaregistry/azure-schemaregistry
+[schemaregistry_avroencoder_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.12.2/sdk/schemaregistry/azure-schemaregistry-avroencoder
 
 ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/eventhub/azure-eventhub/README.png)
 
diff --git a/metadata/latest/azure-eventhub.json b/metadata/latest/azure-eventhub.json
@@ -1,6 +1,6 @@
 {
   "Name": "azure-eventhub",
-  "Version": "5.12.1",
+  "Version": "5.12.2",
   "DevVersion": null,
   "DirectoryPath": "sdk/eventhub/azure-eventhub",
   "ServiceDirectory": "eventhub",
@@ -10,7 +10,11 @@
   "SdkType": "client",
   "IsNewSdk": true,
   "ArtifactName": "azure-eventhub",
-  "ReleaseStatus": "2024-06-11",
+  "ReleaseStatus": "2024-10-02",
+  "IncludedForValidation": false,
+  "AdditionalValidationPackages": [
+    ""
+  ],
   "Namespaces": [
     "azure.eventhub"
   ],
