Azure Synapse

Available when using an authoring Data Collector version 4.0.0 or later.

To create an Azure Synapse connection, the appropriate Azure Synapse stage library must be installed on the selected authoring Data Collector:
  • Data Collector 5.5.x and later - Requires the Azure stage library, streamsets-datacollector-azure-lib.
  • Data Collector 4.0.0 to 5.4.x - Requires version 1.2.0 or later of the Azure Synapse Enterprise stage library, streamsets-datacollector-azure-synapse-lib.

For a description of the Azure Synapse connection properties, see Azure Synapse Connection Properties.

After you create a Azure Synapse connection, you can use the connection in the following stage:
Engine Stages
Data Collector 4.0.0 or later
  • Azure Synapse SQL destination

Azure Synapse Authentication

The Azure Synapse connection requires authentication details to connect to your Azure Synapse instance. You can use one of the following authentication methods to connect to Azure Synapse:
SQL Login
You specify a user name and password created in the database.
Azure Active Directory
You specify an Azure Active Directory user identity and password. The user identity and password are the credentials used to sign in to the Azure portal. Enter the full user identity, for example: user@mycompany.com.
When you use Azure Active Directory authentication, you can also use Azure Active Directory User authentication for the copy statement connection. For more information about the copy statement connection, see the Data Collector documentation.

Azure Synapse Connection Properties

When creating an Azure Synapse connection, configure the following properties on the Azure Synapse SQL tab:
Azure Synapse SQL Property Description
Azure Synapse Name Name of the Azure Synapse server.

The server name is the first portion of the FQDN.

For example, in the my_synapse.database.windows.net FQDN, the server name is my_synapse.
Azure Synapse Instance Type Azure Synapse Instance type to write to:
  • SQL Pool (database.windows.net) - Use to write to an Azure Synapse dedicated SQL pool.
  • Managed SQL (sql.azuresynapse.net) - Use to write to an Azure SQL Managed Instance.
Azure Synapse Authentication Authentication method used to connect to Azure Synapse:
  • Azure Active Directory Authentication
  • SQL Login
User User name for the connection to the database.

Available when using the SQL Login authentication method.
Password Password for the account.
Tip: To secure sensitive information, you can use credential stores or runtime resources.

Available when using the SQL Login authentication method.
Azure Active Directory ID Azure Active Directory user identity for the connection to the database.

The user identity and password are the credentials used to sign in to the Azure portal. Enter the full user identity, for example: user@mycompany.com.

Available when using the Azure Active Directory authentication method.
Azure Active Directory Password Password for the user identity.
Tip: To secure sensitive information, you can use credential stores or runtime resources.

Available when using the Azure Active Directory authentication method.
Azure Government Account Enables the use of an Azure Government account.

For more information about government accounts, see the Azure documentation.