Microsoft Azure SQL Database connection

To access your data in a Microsoft Azure SQL Database, create a connection asset for it.

Microsoft Azure SQL Database is a managed cloud database that is provided as part of Microsoft Azure.

Create a connection to Microsoft Azure SQL Database

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 SQL Database.

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 SQL Database that is behind a firewall

To connect to a Microsoft Azure SQL Database 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 SQL Database documentation for the correct syntax.

Microsoft Azure SQL Database setup

Getting started with single databases in Azure SQL Database

Configuring lineage metadata import for Microsoft Azure SQL Database

When you create a metadata import for the Microsoft Azure SQL Database connection, you can set options specific to this data source, and define the scope of data for which lineage is generated. For details about metadata import, see Designing metadata imports.

To import lineage metadata for Microsoft Azure SQL Database, complete these steps:

  1. Create a data source definition. Select Microsoft Azure SQL Database as the data source type.
  2. Create a connection to the data source in a project.
  3. Create a metadata import. Learn more about options that are specific to Microsoft Azure SQL Database data source:
    • When you define a scope, you can analyze the entire data source or use the include and exclude options to define the exact databases and schemas that you want to be analyzed. See Include and exclude lists.
    • Optionally, you can provide external input in the form of a .zip file. You add this file in the Add inputs from file field. The file must have a supported structure. See External inputs.
    • Optionally, specify advanced import options.

Include and exclude lists

You can include or exclude assets up to the schema level. Provide databases and schemas in the format database/schema. Each part is evaluated as a regular expression. Assets which are added later in the data source will also be included or excluded if they match the conditions specified in the lists. Example values:

  • myDB/: all schemas in myDB database.
  • myDB2/.*: all schemas in myDB2 database.
  • myDB3/mySchema1: mySchema1 schema from myDB3 database.
  • myDB4/mySchema[1-5]: any schema in my myDB4 database with a name that starts with mySchema and ends with a digit between 1 and 5.

External inputs

If you use external SQL and T-SQL scripts for Microsoft Azure SQL Database, you can add them in a .zip file as an external input. You can organize the structure of a .zip file as subfolders that represent databases and schemas. After the scripts are scanned, they are added under respective databases and schemas in the selected catalog or project. The .zip file can have the following structure:

    <database_name>
        <schema_name>
           <script_name.sql>
    <database_name>
        <script_name.sql>
    <script_name.sql>
    replace.csv
    linkedServerConnectionsConfiguration.prm

The replace.csv file contains placeholder replacements for the scripts that are added in the .zip file. For more information about the format, see Placeholder replacements.

The linkedServerConnectionsConfiguration.prm file contains linked server connection definitions. The following structure defines a single connection:

[{Shortcut_Name}] Type={connection_type}
Connection_String={connection_string}
Server_Name={server_name}
Database_Name={database_name}
Schema_Name={schema_name}
User_Name={user_name}

Advanced import options

Extract extended attributes
You can extract extended attributes like primary key, unique and referential integrity constraints of columns. By default these attributes are not extracted.
Extraction mode
You can decide which extraction mode to run for the imported metadata. You have the following options:
  • Prefetch: use it for relational databases.
  • Parallel bulk: use it for analytical processing engines.
  • Single-thread: use it to avoid parallelism and large queries during extraction. When you select this mode, performance might be low.
Transformation logic extraction
You can enable building transformation logic descriptions from SQL code in SQL scripts.

Learn more

Azure SQL Database documentation

Parent topic: Supported connections