[airflow] branch main updated: Improve documentation for Azure Service Bus hooks DefaultAzureCredential support (#34096)

[po...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 9817be3e10 Improve documentation for Azure Service Bus hooks DefaultAzureCredential support (#34096)
9817be3e10 is described below

commit 9817be3e10659793ed8941cacc60307bcec36109
Author: Wei Lee <we...@gmail.com>
AuthorDate: Tue Sep 5 23:04:05 2023 +0800

    Improve documentation for Azure Service Bus hooks DefaultAzureCredential support (#34096)
    
    * docs(providers/microsoft): improve documentation for Azure Service Bus hooks DefaultAzureCredential support
    
    * doc(providers/microsoft): rewording
    
    Co-authored-by: Tzu-ping Chung <ur...@gmail.com>
    
    * docs(providers/microsoft): extract DefaultAzureCredential link
    
    * docs(providers/microsoft): extract links to doc end
    
    ---------
    
    Co-authored-by: Tzu-ping Chung <ur...@gmail.com>
---
 .../connections/asb.rst                            | 25 ++++++++++++++++------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/docs/apache-airflow-providers-microsoft-azure/connections/asb.rst b/docs/apache-airflow-providers-microsoft-azure/connections/asb.rst
index daf50d6017..848232836a 100644
--- a/docs/apache-airflow-providers-microsoft-azure/connections/asb.rst
+++ b/docs/apache-airflow-providers-microsoft-azure/connections/asb.rst
@@ -27,12 +27,14 @@ The Microsoft Azure Service Bus connection type enables the Azure Service Bus In
 Authenticating to Azure Service Bus
 ------------------------------------
 
-There are multiple ways to authenticate and authorize access to Azure Service Bus resources:
-Currently Supports Shared Access Signatures (SAS).
+There are two ways to authenticate and authorize access to Azure Service Bus resources:
 
-1. Use a `Connection String
-   <https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quickstart-portal#get-the-connection-string>`_
+1. Use a `Connection String`_
    i.e. Use connection string Field to add ``Connection String`` in the Airflow connection.
+2. Fallback on DefaultAzureCredential_.
+   This includes a mechanism to try different options to authenticate: Managed System Identity, environment variables, authentication through Azure CLI and etc.
+   ``fully_qualified_namespace`` is required in this authentication mechanism.
+
 
 Default Connection IDs
 ----------------------
@@ -42,9 +44,18 @@ All hooks and operators related to Microsoft Azure Service Bus use ``azure_servi
 Configuring the Connection
 --------------------------
 
-Connection String
+Connection String (optional)
     Specify the Azure Service bus connection string ID used for the initial connection.
     Please find the documentation on how to generate connection string in azure service bus
-    `Get connection string
-    <https://docs.microsoft.com/en-gb/azure/service-bus-messaging/service-bus-create-namespace-portal#get-the-connection-string.>`_
+    `Get connection string`_
     Use the key ``connection_string`` to pass in the Connection ID .
+    It can be left out to fall back on DefaultAzureCredential_.
+
+Fully Qualified Namespace (optional)
+   Specify the fully qualified Service Bus namespace that the connection is associated with. This is likely to be similar to ``{yournamespace}.servicebus.windows.net``.
+   Use the key ``fully_qualified_namespace`` to pass in the Connection ID .
+   This is required when falling back to DefaultAzureCredential_.
+
+.. _Connection String: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quickstart-portal#get-the-connection-string
+.. _DefaultAzureCredential: https://docs.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python#defaultazurecredential
+.. _Get connection string: https://docs.microsoft.com/en-gb/azure/service-bus-messaging/service-bus-create-namespace-portal#get-the-connection-string