.. 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_synapse:

Microsoft Azure Synapse

The Microsoft Azure Synapse connection type enables the Azure Synapse Integrations.

Authenticating to Azure Synapse

There are three ways to connect to Azure Synapse 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 subscription id to the Airflow connection.
2. Use managed identity by setting managed_identity_client_id, workload_identity_tenant_id (under the hook, it uses DefaultAzureCredential_ with these arguments)
3. Fallback on 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 Synapse use azure_synapse_default by default.

Configuring the Connection

Client ID 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.

Secret Specify the secret used for the initial connection. This is needed for token credentials authentication mechanism. It can be left out to fall back on DefaultAzureCredential.

Tenant ID Specify the tenantId used for the initial connection. This is needed for token credentials authentication mechanism. It can be left out to fall back on DefaultAzureCredential.

Subscription ID subscriptionId is required for the connection. This is needed for all authentication mechanisms.

Synapse Workspace URL Specify the Azure Synapse endpoint to interface with.

.. _DefaultAzureCredential: https://docs.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python#defaultazurecredential

.. spelling:word-list::

Entra