From 773e48b719256b05fcdb1e41f14049d6860fb68b Mon Sep 17 00:00:00 2001 From: "Adam Ling (MSFT)" Date: Mon, 8 Mar 2021 13:17:15 -0800 Subject: [PATCH] [EventHubs] Preview release doc fix (#17166) --- sdk/eventhub/azure-eventhub/CHANGELOG.md | 2 +- sdk/eventhub/azure-eventhub/doc/azure.eventhub.rst | 5 +++++ sdk/eventhub/azure-eventhub/migration_guide.md | 6 +++--- sdk/eventhub/azure-eventhub/samples/README.md | 2 +- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/CHANGELOG.md b/sdk/eventhub/azure-eventhub/CHANGELOG.md index 9b2a1d21e643..d3807b8dd413 100644 --- a/sdk/eventhub/azure-eventhub/CHANGELOG.md +++ b/sdk/eventhub/azure-eventhub/CHANGELOG.md @@ -10,7 +10,7 @@ This version and all future versions will require Python 2.7 or Python 3.6+, Pyt events that are published. - `EventHubProducerClient` constructor accepts two new parameters for idempotent publishing: - `enable_idempotent_partitions`: A boolean value to tell the `EventHubProducerClient` whether to enable idempotency. - - `partition_configs`: The set of configurations that can be specified to influence publishing behavior + - `partition_config`: The set of configurations that can be specified to influence publishing behavior specific to the configured Event Hub partition. - Introduced a new method `get_partition_publishing_properties` on `EventHubProducerClient` to inspect the information about the state of publishing for a partition. diff --git a/sdk/eventhub/azure-eventhub/doc/azure.eventhub.rst b/sdk/eventhub/azure-eventhub/doc/azure.eventhub.rst index d4b20de11f3d..a9bdd215a879 100644 --- a/sdk/eventhub/azure-eventhub/doc/azure.eventhub.rst +++ b/sdk/eventhub/azure-eventhub/doc/azure.eventhub.rst @@ -45,11 +45,16 @@ azure.eventhub package :members: :undoc-members: :inherited-members: + .. autoclass:: azure.eventhub.LoadBalancingStrategy :members: :undoc-members: :inherited-members: + .. autoclass:: azure.eventhub.PartitionPublishingConfiguration + :members: + :undoc-members: + :inherited-members: Subpackages ----------- diff --git a/sdk/eventhub/azure-eventhub/migration_guide.md b/sdk/eventhub/azure-eventhub/migration_guide.md index 6510bfc6b79f..f63f3de810ad 100644 --- a/sdk/eventhub/azure-eventhub/migration_guide.md +++ b/sdk/eventhub/azure-eventhub/migration_guide.md @@ -2,7 +2,7 @@ This guide is intended to assist in the migration to `azure-eventhub` v5 from v1. It will focus on side-by-side comparisons for similar operations between the two packages. -Familiarity with the `azure-eventhub` v1 package is assumed. For those new to the Event Hubs client library for Python, please refer to the [README for `azure-eventhub`](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/README.md) rather than this guide. +Familiarity with the `azure-eventhub` v1 package is assumed. For those new to the Event Hubs client library for Python, please refer to the [README for `azure-eventhub`](https://github.com/Azure/azure-sdk-for-python/blob/feature/eventhub/idempotent-producer/sdk/eventhub/azure-eventhub/README.md) rather than this guide. ## Table of contents @@ -39,7 +39,7 @@ We have a variety of new features in version 5 of the Event Hubs library. - Ability to configure the retry policy used by operations on the clients. - Authentication with AAD credentials using [`azure-identity`](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/identity/azure-identity/README.md). -Refer to the [changelog](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/CHANGELOG.md) for more new features, changes and bug fixes. +Refer to the [changelog](https://github.com/Azure/azure-sdk-for-python/blob/feature/eventhub/idempotent-producer/sdk/eventhub/azure-eventhub/CHANGELOG.md) for more new features, changes and bug fixes. ## Important changes @@ -288,4 +288,4 @@ if __name__ == '__main__': ## Additional samples -More examples can be found at [Samples for azure-eventhub](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples) \ No newline at end of file +More examples can be found at [Samples for azure-eventhub](https://github.com/Azure/azure-sdk-for-python/tree/feature/eventhub/idempotent-producer/sdk/eventhub/azure-eventhub/samples) \ No newline at end of file diff --git a/sdk/eventhub/azure-eventhub/samples/README.md b/sdk/eventhub/azure-eventhub/samples/README.md index 2a815f38810c..6e16b656d3d4 100644 --- a/sdk/eventhub/azure-eventhub/samples/README.md +++ b/sdk/eventhub/azure-eventhub/samples/README.md @@ -89,7 +89,7 @@ There, you can also find detailed instructions for using the Azure CLI, Azure Po 1. Install the Azure Event Hubs client library for Python with [pip](https://pypi.org/project/pip/): ```bash -pip install azure-eventhub +pip install azure-eventhub --pre ``` To run samples that utilize the Azure Active Directory for authentication, please install the `azure-identity` library: