Microsoft Azure Synapse SQL (Data Warehouse): Add Database Connection

To define a new connection from the Connection parameter in a Microsoft Azure Synapse SQL (Data Warehouse) format:

  • Select Add Database Connection. See database-specific parameters below, as well as the section Adding a Database Connection in a Workspace in Using Database Connections The new connection can be made visible only to the current user, or can be shared among multiple users.
Note  To select an existing, previously defined connection, see the section Reusing a Database Connection in Using Database Connections

Database Connection

Microsoft Azure Synapse SQL (Data Warehouse)

Name

Enter a name for the new connection.

Connection Parameters

Server

The host name of the Microsoft Azure Synapse SQL Pool.

Database

To initiate a database connection, enter (or browse for) the database name.

Authentication

  • SQL Server Authentication – Connect using a SQL Server login account, specified through the Username and Password parameters.
  • Microsoft Entra MFA – Connect using a dialog box pop-up that displays the specified username and asks for a password. This method supports multi-factor authentication.
  • Microsoft Entra Password – Connect using an identity that is defined in Microsoft Entra (formerly Azure Active Directory). The Username and Password parameters should match the username and password of the identity in Microsoft Entra.
  • Microsoft Entra Integrated – Connect using the current Windows user identity that is defined in Microsoft Entra (formerly Azure Active Directory). This authentication mode requires the on-premises ​​Active Directory Federation Services (ADFS) to be federated with the Microsoft Entra ID in the cloud.
  • OAuth Connection – Connect using Microsoft Azure Active Directory OAuth 2.0 web service or Client Credentials web service by selecting a Web Connection in the OAuth Connection parameter.

Enter the username and password to access the service.

The web connection to use to obtain a valid OAuth token. This option is enabled when the OAuth Connection authentication method is selected.

Note  To connect using Microsoft Azure Active Directory OAuth 2, make sure that a valid Microsoft Azure Active Directory (AD) web service has been configured before creating a web connection.

A Microsoft Azure Active Directory (Template) web service has been provided in your FME installation. To configure a new Microsoft Azure AD web service, create a new web service from this template, replacing [TENANT_ID] and [AUTHORIZATION_SCOPE] with the appropriate values.

For more information, see Register an application in Microsoft Entra ID on the Microsoft documentation website and Creating an OAuth 2.0 Web Service and Connection in FME.

For Client Credentials authentication, please create a new web connection using the provided Microsoft Azure Active Directory (Client Credentials) web service.

When enabled, this parameter will allow the JDBC connection string and properties to be specified directly, in order to connect to the database.

Input

Description

Connection String

The connection string for the database to which you are connecting.

Password

An optional parameter if the connection requires a password.

Mask Connection Details

  • When this option is checked (set to Yes) – Connection strings and properties for database connections are masked in translation and error logs.

Connection details may contain sensitive information, such as passwords. A masked connection string appears as:

jdbc:<subprotocol>:************

While masked connection properties appear as:

{<property_name1>=************,
<property_name2>=************, ...}

Connection strings for connections whose parameters are embedded in the workspace are not masked, regardless of this setting.

  • When this option is left unchecked (set to No) – Connection strings and properties are logged in plain text.

Connection Property and Value

JDBC connections can be configured with driver-specific arbitrary name/value pairs. The name/value pairs can often be specified in either the Connection String or a Properties object (sometimes only in one way or the other).

Name/value pairs entered here will be set in the order specified, then passed on in a Properties object. They do not require manual encoding of characters that are not safe in Connection Strings.