From 579c49dc4c61745868da47c28765c4a98ecb29e0 Mon Sep 17 00:00:00 2001 From: Swathi Pillalamarri Date: Fri, 15 Jan 2021 19:49:25 -0500 Subject: [PATCH 1/2] updated README with install steps for azure-identity and aiohttp --- sdk/eventhub/azure-eventhub/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index 965c857dd929..e77d2dc702a9 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -56,6 +56,14 @@ Alternately, one can use a Credential object to authenticate via AAD with the az [TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/master/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 `TokenCredential` type, or other credential types provided with the Azure SDK, please install the `azure-identity` package: + +```pip install azure-identity``` + +- Additionally, to use the async API supported on Python 3.5+, please install the async transport [`aiohttp`](https://pypi.org/project/aiohttp/): + +```pip install aiohttp``` + - When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, please refer to [the associated documentation](https://docs.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory). From e8dd9c8e9d3c85b5d994cd03b2cbf1b8ad9425d3 Mon Sep 17 00:00:00 2001 From: swathipil <76007337+swathipil@users.noreply.github.com> Date: Wed, 20 Jan 2021 18:08:02 -0500 Subject: [PATCH 2/2] wording + clarity on credential types/async transport Co-authored-by: Adam Ling (MSFT) --- sdk/eventhub/azure-eventhub/README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index e77d2dc702a9..36caca519e46 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -56,14 +56,10 @@ Alternately, one can use a Credential object to authenticate via AAD with the az [TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/master/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 `TokenCredential` type, or other credential types provided with the Azure SDK, please install the `azure-identity` package: - +- To use the credential types provided by `azure-identity`, please install the package: ```pip install azure-identity``` - -- Additionally, to use the async API supported on Python 3.5+, please install the async transport [`aiohttp`](https://pypi.org/project/aiohttp/): - +- Additionally, to use the async API supported on Python 3.5+, you must first install an async transport, such as [`aiohttp`](https://pypi.org/project/aiohttp/): ```pip install aiohttp``` - - When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, please refer to [the associated documentation](https://docs.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory).