Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(providers/microsoft): improve documentation for AzureDataLakeHook DefaultAzureCredential support #34074

Merged
merged 1 commit into from
Sep 4, 2023
Merged

docs(providers/microsoft): improve documentation for AzureDataLakeHook DefaultAzureCredential support #34074

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/apache-airflow-providers-microsoft-azure/connections/adl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ There is one way to connect to Azure Data Lake using Airflow.
1. Use `token credentials
<https://docs.microsoft.com/en-us/azure/developer/python/azure-sdk-authenticate?tabs=cmd#authenticate-with-token-credentials>`_
i.e. add specific credentials (client_id, secret, tenant) and account name to the Airflow connection.
2. Fallback on `DefaultAzureCredential
<https://docs.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python#defaultazurecredential>`_.
This includes a mechanism to try different options to authenticate: Managed System Identity, environment variables, authentication through Azure CLI...

Default Connection IDs
----------------------
Expand All @@ -41,20 +44,23 @@ All hooks and operators related to Microsoft Azure Data Lake use ``azure_data_la
Configuring the Connection
--------------------------

Login
Login (optional)
Specify the ``client_id`` used for the initial connection.
This is needed for *token credentials* authentication mechanism.
It can be left out to fall back on ``DefaultAzureCredential``.

Password
Password (optional)
Specify the ``secret`` used for the initial connection.
This is only needed for *token credentials* authentication mechanism.
It can be left out to fall back on ``DefaultAzureCredential``.

Extra (optional)
Specify the extra parameters (as json dictionary) that can be used in Azure Data Lake connection.
The following parameters are all optional:

* ``tenant``: Specify the tenant to use.
* ``tenant``: (optional) Specify the tenant to use.
This is needed for *token credentials* authentication mechanism.
It can be left out to fall back on ``DefaultAzureCredential``.
* ``account_name``: Specify the azure data lake account name.
This is sometimes called the ``store_name``

Expand Down