Microsoft Azure Synapse Analytics connection

To access your data in a Microsoft Azure Synapse Analytics, create a connection asset for it.

Microsoft Azure Synapse Analytics is a data warehouse anayltics service provided as part of Microsoft Azure.

Note: This connection only supports the dedicated SQL pool.

Create a connection to Microsoft Azure Synapse Analytics

To create the connection asset, you need these connection details:

  • Database name
  • Hostname or IP address
  • Port number
  • SSL certificate (if required by the database server)

Credentials

Choose an authentication method:

Username and password
Username and Password to access the database in Microsoft Azure Synapse Analytics.

Note: Prerequisite for Entra ID authentication:

Microsoft Entra ID is a cloud-based identity and access management service. To obtain connection values for the Entra ID authentication method, sign in to the Microsoft Azure portal. For information about Entra ID, refer to the following Microsoft documentation:

Entra ID client secret credential

  • Client ID: The client ID for authorizing access to Microsoft Azure. To find the Client ID for your application, select Microsoft Entra ID. From App registrations, select your application. Click Copy to copy the Client ID of your application. For more information, see Register a Microsoft Entra app and create a service principal.
  • Client secret: The authentication key that is associated with the client ID for authorizing access to Microsoft Azure. To find the Client secret for your application, select Microsoft Entra ID. From App registrations, select your application. Go to Certificates & secrets > Client secrets. Click Copy to copy the existing Client secret or click New client secret to create a new Client secret and copy it. For more information, see Register a Microsoft Entra app and create a service principal.

Entra ID username password credential
Username and Password for the Microsoft Azure account.

For Credentials and Certificates, you can use secrets if a vault is configured for the platform and the service supports vaults. For information, see Using secrets from vaults in connections.

Connect to a Microsoft Azure Synapse Analytics that is behind a firewall

To connect to a Microsoft Azure Synapse Analytics that is behind a firewall, you must add the IP addresses of the cluster worker nodes to the firewall.

  1. Find the IP addresses of the cluster worker nodes. Log in to Cloud Pak for Data and run this command:
    oc get nodes -o wide
  2. Note the IP addresses in the ROLE column that are identified as worker.
  3. Use Windows Azure Management Portal or run sp_set_firewall_rule on the master database to create a firewall rule for the IP addresses of the cluster worker nodes.

For more information, see Azure SQL Database and Azure Synapse IP firewall rules.

Choose the method for creating a connection based on where you are in the platform

In a project
Click Assets > New asset > Prepare data > Connect to a data source. See Adding a connection to a project.
In a catalog
Click Add to catalog > Connection. See Adding a connection asset to a catalog.
In a deployment space
Click Import assets > Data access > Connection. See Adding data assets to a deployment space.
In the Platform assets catalog
Click New connection. See Adding platform connections.

Next step: Add data assets from the connection

Federal Information Processing Standards (FIPS) compliance

This connection can be used on a FIPS-enabled cluster (FIPS tolerant); however, it is not FIPS-compliant.

Running SQL statements

To ensure that your SQL statements run correctly, refer to the Azure Synapse SQL documentation for the correct syntax.

Microsoft Azure Synapse Analytics setup

Get started with Azure Synapse Analytics

Learn more

Azure Synapse Analytics documentation

Parent topic: Supported connections