• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Configuring a Linked Service

Connections can be enabled to be used as Linked Services in Azure Data Factory (ADF).

Enable a Connection as a Linked Service

In the Connection Tab of the Connection Editor, provide the Integration Stage, Connection Type, and System Type for the connection.

If the resulting configuration provided is compatible with a Linked Service, then a Cloud setting will appear in the action bar.

After toggling the Cloud setting, a tab for Linked Services will appear at the bottom of the form and any available linked services will appear in the Linked Service Types dropdown. Select a Linked Service Type to configure it.

Configuring the Linked Service

Linked Services are used in Azure Data Factory (ADF) to define a data source. The Linked Service form allows for input of all required data points needed to allow BimlFlex to generate a corresponding Linked Service.

Important

To configure a Linked Service, select a Connection and enable the Cloud selector at the top.

ADF Linked Service Tab

There are two main components, the base Linked Service details and then the Connection details. These details will remain unchanged regardless of how the connection details are configured.

  • Description
  • Example
Field Description
Linked Service Type The type of Linked Service being used
Connect Via Integration Runtime* (If required) The name of the Integration Runtime to use to connect
Tip

*: This setting is generally only used for an On-Premises data source.

Field Example
Linked Service Type Azure Synapse Analytics (SQL DW)
Connect Via Integration Runtime* AutoResolveIntegrationRuntime
Tip

*: Use AutoResolveIntegrationRuntime if no specific Integration Runtime is needed.

The linked services that are currently supported are listed below. Select a linked service type for information on filling out the Linked Service form.

  • Azure Blob Storage
  • Azure My SQL
  • Azure PostgreSQL
  • Azure SQL Database
  • Azure SQL Database Managed Instance (Azure SQL MI)
  • Azure Synapse Analytics (Azure SQL Data Warehouse)
  • Data Lake Gen 2
  • MySQL
  • Oracle
  • PostgreSQL
  • Snowflake
  • SQL Server
  • Teradata

Linked Service Connection Details

The Connection String can be entered via plain text or stored in an AKV Secret.

  • Azure Key Vault
  • Connection String

Showing configuration for storing a connection string in an Azure Key Vault Secret.

Showing configuration for plain text connection string.

  • Description
  • Example
  • Description
  • Example
Field Description
AKV Linked Service Name of the Linked Service pointing to the AKV
Secret Name Name of the secret
Secret Version (Optional) Version of the secret to use. Leave blank for latest.
Field Example
AKV Linked Service bfx-kv
Secret Name BFX-DW-ConnectionString
Secret Version {Blank}
Field Description
Fully Qualified Domain Name Fully qualified server name
Database Name Name of the database
Field Example
Fully Qualified Domain Name bfx-sql-server.database.windows.net
Database Name BFX_DW

Authentication Details

Depending on the Authentication Method, options to specify an AKV Secret for either a User's Password or Service can also be provided.

  • SQL Authentication
  • SQL Authentication
  • Managed Identity
  • Service Principal
Field Example
Authentication Method SQL Authentication
Field Example
Authentication Method SQL Authentication
Field Example
Authentication Method Managed Identity
Field Example
Authentication Method Service Principal
  • Authentication Details: N/A
  • Authentication Details: N/A
  • Azure Key Vault
  • Password
  • Azure Key Vault
  • Service Principal Key
Important

Authentication handled with the value in the connection string Secret.

Important

Authentication handled with the Managed Identity.

Showing configuration for storing a password in an Azure Key Vault Secret.

Showing configuration for plain text password.

Warning

This method is not recommended. The Password is being stored in plain text.

Showing configuration for storing a Service Principal Key in an Azure Key Vault Secret.

Showing configuration for plain text Service Principal Key.

Warning

This method is not recommended. The Service Principal Key is being stored in plain text.

  • Description: N/A
  • Description: N/A
  • Description
  • Example
  • Description
  • Example
  • Description
  • Example
  • Description
  • Example

No description.

No description.

Field Description
AKV Linked Service Name of the Linked Service pointing to the AKV
Secret Name Name of the secret
Secret Version (Optional) Version of the secret to use. Leave blank for latest.
Field Example
AKV Linked Service bfx-kv
Secret Name BFX-DW-Password
Secret Version {Blank}
Field Description
Password The value for the password
Additional Connection String Properties Any additional properties entered here will be included in the Connection String
Field Example
Password P@$$Word!
Additional Connection String Properties key=value;secondKey=secondValue
Field Description
AKV Linked Service Name of the Linked Service pointing to the AKV
Secret Name Name of the secret
Secret Version (Optional) Version of the secret to use. Leave blank for latest.
Field Example
AKV Linked Service bfx-kv
Secret Name BFX-DW-ServicePrincipalKey
Secret Version {Blank}
Field Description
Service Principal Key The value for the Service Principal Key.
Additional Connection String Properties Any additional properties entered here will be included in the Connection String
Field Example
Service Principal Key {Service Principal Key}
Additional Connection String Properties key=value;secondKey=secondValue

[connections-module-list]: images/bimlflex-ss-app-connections-menu-list.png "Connections Module Menu" [connections-details-tab]: images/bimlflex-ss-app-connections-details-tab.png "Connection Details Tab" [connections-linked-service-dropdown]: images/bimlflex-ss-app-connections-cloud-linked-service-select-blank-highlighted.png "Linked Service Type Dropdown" [akv]: images/bimlflex-ss-app-connections-akv.png "Azure Key Vault" [akv-dd]: images/bimlflex-ss-app-connections-akv-dd.png "Azure Key Vault Drop Down"

© Varigence