Azure Synapse Analytics connection

Introduction

An Azure Synapse Analytics connection, created using the Azure Synapse Analytics connector, establishes access to Azure Synapse Analytics. These activities, once configured, interact with Azure Synapse Analytics through the connection.

Create or edit an Azure Synapse Analytics connection

A new Azure Synapse Analytics connection is created using the Azure Synapse Analytics connector from one of these locations:

The design component palette's Project endpoints and connectors tab (see Design component palette).
The Global Connections page (see Create a global endpoint in Global Connections).

An existing Azure Synapse Analytics connection can be edited from these locations:

The design component palette's Project endpoints and connectors tab (see Design component palette).
The project pane's Components tab (see Component actions menu in Project pane Components tab).
The Global Connections page (see Edit a global endpoint in Global Connections).

Configure an Azure Synapse Analytics connection

Each user interface element of the Azure Synapse Analytics connection configuration screen is described below.

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Connection Name: Enter a name to use to identify the connection. The name must be unique for each Azure Synapse Analytics connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Azure Synapse Analytics endpoint, which refers to both a specific connection and its activities.
Server: Enter the server.
Auth Scheme: Select the authorization scheme, one of:
- AzureAD
  - Initiate OAuth: Select the OAuth setting, one of:
    - OFF
      - OAuth Access Token: Enter the OAuth access token.
    - GETANDREFRESH
    - REFRESH
      - OAuth Access Token: Enter the OAuth access token.
  - OAuth Refresh Token: Enter the OAuth refresh token.
- AzureMSI
- AzureServicePrincipal
  - Azure Tenant: Enter the Azure tenant.
  - Initiate OAuth: Select the OAuth setting, one of:
    - OFF
      - OAuth Access Token: Enter the OAuth access token.
    - GETANDREFRESH
    - REFRESH
      - OAuth Access Token: Enter the OAuth access token.
  - OAuth Client Id: Enter the OAuth client ID.
  - OAuth Client Secret: Enter the OAuth client secret.
  - OAuth Refresh Token: Enter the OAuth refresh token.
- AzureServicePrincipalCert
  - Azure Tenant: Enter the Azure tenant.
  - Initiate OAuth: Select the OAuth setting, one of:
    - OFF
      - OAuth Access Token: Enter the OAuth access token.
    - GETANDREFRESH
    - REFRESH
      - OAuth Access Token: Enter the OAuth access token.
  - OAuth Client Id: Enter the OAuth client ID.
  - OAuth Refresh Token: Enter the OAuth refresh token.
  - OAuth JWT Cert: Enter the OAuth JWT certificate.
  - OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:
    - USER
    - MACHINE
    - PFXFILE
    - PFXBLOB
    - JKSFILE
    - JKSBLOB
    - PEMKEY_FILE
    - PEMKEY_BLOB
    - PUBLIC_KEY_FILE
    - PUBLIC_KEY_BLOB
    - SSHPUBLIC_KEY_FILE
    - SSHPUBLIC_KEY_BLOB
    - P7BFILE
    - PPKFILE
    - XMLFILE
    - XMLBLOB
  - OAuth JWT Cert Password: Enter the OAuth JWT certificate password.
  - OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.
- Password
  - User: Enter the user.
  - Password: Enter the password.
- AzurePassword
  - User: Enter the user.
  - Password: Enter the password.
  - Azure Tenant: Enter the Azure tenant.
Port: Enter the port.
Database: Enter the database.
Encrypt: When selected, specifies to use encrypt.
Use Proxy Settings: Select to use private agent proxy settings.
Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.

Click the add icon to add a row to the table below and enter a key-value pair for each property.

To save the row, click the submit icon in the rightmost column.

To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

To delete all rows, click Clear All.

Important

Fields in the Advanced Configurations table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.
Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
Save Changes: Click to save and close the connection configuration.
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After an Azure Synapse Analytics connector connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

Query: Retrieves records from a table at Azure Synapse Analytics and is intended to be used as a source in an operation.
Create: Inserts a record into a table at Azure Synapse Analytics and is intended to be used as a target in an operation.
Update: Updates a record in a table at Azure Synapse Analytics and is intended to be used as a target in an operation.
Delete: Deletes a record from a table at Azure Synapse Analytics and is intended to be used as a target in an operation.
Execute: Executes a procedure at Azure Synapse Analytics and is intended to be used as a target in an operation.