eladkal commented on code in PR #24038: URL: https://github.com/apache/airflow/pull/24038#discussion_r897736894
########## docs/apache-airflow-providers-microsoft-azure/connections/asb.rst: ########## @@ -0,0 +1,52 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + + +.. _howto/connection:azure_service_bus: + +Microsoft Azure Service Bus +======================================= + +The Microsoft Azure Service Bus connection type enables the Azure Service Bus Integration. + +Authenticating to Azure Service Bus +------------------------------------ + +There are two ways to authenticate and authorize access to Azure Service Bus resources: +Azure Active Directory (Azure AD) and Shared Access Signatures (SAS). + +1. Use `Azure Active Directory + <https://docs.microsoft.com/en-gb/azure/service-bus-messaging/service-bus-authentication-and-authorization#azure-active-directory>`_ + i.e. add specific credentials (client_id, secret, tenant) and subscription id 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 +---------------------- + +All hooks and operators related to Microsoft Azure Service Bus use ``azure_service_bus_default`` by default. + +Configuring the Connection +-------------------------- + +Connection String + Specify the Azure Service bus connection string ID used for the initial connection. + `Get connection string + <https://docs.microsoft.com/en-gb/azure/service-bus-messaging/service-bus-create-namespace-portal#get-the-connection-string.>`_ + Use the key ``connection_string`` to pass in the Connection ID . Review Comment: We should have that in a connection type doc like we have for other Azure services: https://airflow.apache.org/docs/apache-airflow-providers-microsoft-azure/stable/connections/index.html I think you will need to create `connections/asb.rst` and add the information about the connection there. You can check other services as example: https://github.com/apache/airflow/blob/831e84d9c30e50a11f0419a807c0e4b6dac63213/docs/apache-airflow-providers-microsoft-azure/connections/wasb.rst -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
