[Event Hubs] Eventhubs doc update (#10129)

Azure · Mar 6, 2020 · 998b6fa · 998b6fa
1 parent f4aaf8d
commit 998b6fa
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 52 deletions.
diff --git a/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/CHANGELOG.md b/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.1 (Unreleased)
+## 1.0.1 (2020-03-09)
 
 **New features**
 - Param `api_version` of `BlobCheckpointStore` now supports older versions of Azure Storage Service API.

diff --git a/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/README.md b/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/README.md
@@ -9,13 +9,7 @@ Please note that this is an async library, for sync version of the Azure EventHu
 
 ## Getting started
 
-### Install the package
-
-```
-$ pip install azure-eventhub-checkpointstoreblob-aio
-```
-
-**Prerequisites**
+### Prerequisites
 
 - Python 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://azure.microsoft.com/en-us/).
@@ -24,6 +18,11 @@ $ pip install azure-eventhub-checkpointstoreblob-aio
 
 - **Azure Storage Account:** You'll need to have an Azure Storage Account and create a Azure Blob Storage Block Container to store the checkpoint data with blobs. You may follow the guide [creating an Azure Block Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-create-account-block-blob).
 
+### Install the package
+
+```
+$ pip install azure-eventhub-checkpointstoreblob-aio
+```
 
 ## Key concepts
 
@@ -107,7 +106,14 @@ version, specify `api_version` when you create the `BlobCheckpointStore` object.
 
 ### General
 Enabling logging will be helpful to do trouble shooting.
-Refer to [Logging](#logging) to enable loggers for related libraries.
+
+### Logging
+
+- Enable `azure.eventhub.extensions.checkpointstoreblobaio` logger to collect traces from the library.
+- Enable `azure.eventhub` logger to collect traces from the main azure-eventhub library.
+- Enable `azure.eventhub.extensions.checkpointstoreblobaio._vendor.storage` logger to collect traces from azure storage blob 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
 
@@ -118,14 +124,6 @@ Refer to [Logging](#logging) to enable loggers for related libraries.
 
 Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.0.0/azure.eventhub.aio.html#azure.eventhub.aio.CheckpointStore)
 
-### Logging
-
-- Enable `azure.eventhub.extensions.checkpointstoreblobaio` logger to collect traces from the library.
-- Enable `azure.eventhub` logger to collect traces from the main azure-eventhub library.
-- Enable `azure.eventhub.extensions.checkpointstoreblobaio._vendor.storage` logger to collect traces from azure storage blob 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.
-
 ### 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.

diff --git a/sdk/eventhub/azure-eventhub-checkpointstoreblob/CHANGELOG.md b/sdk/eventhub/azure-eventhub-checkpointstoreblob/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.1 (Unreleased)
+## 1.0.1 (2020-03-09)
 
 **New features**
 - Param `api_version` of `BlobCheckpointStore` now supports older versions of Azure Storage Service API.

diff --git a/sdk/eventhub/azure-eventhub-checkpointstoreblob/README.md b/sdk/eventhub/azure-eventhub-checkpointstoreblob/README.md
@@ -9,13 +9,7 @@ Please note that this is a sync library, for async version of the Azure EventHub
 
 ## Getting started
 
-### Install the package
-
-```
-$ pip install azure-eventhub-checkpointstoreblob
-```
-
-**Prerequisites**
+### Prerequisites
 
 - Python2.7, Python 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://azure.microsoft.com/en-us/).
@@ -24,6 +18,12 @@ $ pip install azure-eventhub-checkpointstoreblob
 
 - **Azure Storage Account:** You'll need to have an Azure Storage Account and create a Azure Blob Storage Block Container to store the checkpoint data with blobs. You may follow the guide [creating an Azure Block Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-create-account-block-blob).
 
+### Install the package
+
+```
+$ pip install azure-eventhub-checkpointstoreblob
+```
+
 ## Key concepts
 
 ### Checkpointing
@@ -105,7 +105,14 @@ version, specify `api_version` when you create the `BlobCheckpointStore` object.
 
 ### General
 Enabling logging will be helpful to do trouble shooting.
-Refer to [Logging](#logging) to enable loggers for related libraries.
+
+### Logging
+
+- Enable `azure.eventhub.extensions.checkpointstoreblob` logger to collect traces from the library.
+- Enable `azure.eventhub` logger to collect traces from the main azure-eventhub library.
+- Enable `azure.eventhub.extensions.checkpointstoreblob._vendor.storage` logger to collect traces from azure storage blob 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
 
@@ -116,14 +123,6 @@ Refer to [Logging](#logging) to enable loggers for related libraries.
 
 Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.0.0/azure.eventhub.html#azure.eventhub.CheckpointStore)
 
-### Logging
-
-- Enable `azure.eventhub.extensions.checkpointstoreblob` logger to collect traces from the library.
-- Enable `azure.eventhub` logger to collect traces from the main azure-eventhub library.
-- Enable `azure.eventhub.extensions.checkpointstoreblob._vendor.storage` logger to collect traces from azure storage blob 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.
-
 ### 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.

diff --git a/sdk/eventhub/azure-eventhub/CHANGELOG.md b/sdk/eventhub/azure-eventhub/CHANGELOG.md
@@ -1,10 +1,12 @@
 # Release History
 
-## 5.0.1 (Unreleased)
+## 5.0.1 (2020-03-09)
 
 **Bug fixes**
 
-- Fixed a bug that `azure.eventhub.EventHubConsumerClient.receive()` doesn't call error handler callback on_error #9660
+- 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)
 

diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md
@@ -17,17 +17,9 @@ The Azure Event Hubs client library allows for publishing and consuming of Azure
 
 ## Getting started
 
-### Install the package
-
-Install the Azure Event Hubs client library for Python with pip:
-
-```
-$ pip install azure-eventhub
-```
+### Prerequisites
 
-**Prerequisites**
-
-- Python 2.7, 3.5 or later.
+- 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).
 
@@ -36,6 +28,14 @@ If you are not familiar with creating Azure resources, you may wish to follow th
 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.
@@ -351,6 +351,12 @@ The Event Hubs APIs generate the following exceptions in azure.eventhub.exceptio
 - **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
@@ -361,12 +367,6 @@ Please take a look at the [samples](./samples) directory for detailed examples o
 
 Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.0.0/azure.eventhub.html).
 
-### 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.
-
 ### 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.