Microsoft Azure Synapse

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

Authenticating to Azure Synapse

There are multiple ways to connect to Azure Synapse using Airflow.

  1. Use token credentials i.e. add specific credentials (client_id, secret, tenant) and subscription id to 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…

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 Azure tenant ID used for the initial connection. This is needed for token credentials authentication mechanism. It can be left out to fall back on DefaultAzureCredential. Use the key extra__azure_synapse__tenantId to pass in the tenant ID.

Subscription ID

A subscription ID is required for the connection. This is needed for all authentication mechanisms. Use the key extra__azure_synapse__subscriptionId to pass in the Azure subscription ID.

Synapse Workspace URL

Specify the Azure Synapse endpoint to interface with.

Was this entry helpful?