Azure Synapse Connection Profile Parameters

The following table describes Azure Synapse connection profile parameters:

Parameter

Description

Authentication Method

Determines one of the following identity types to connect to Azure Synapse Analytics:

  • Managed Identity: Enables you to access other Azure AD-protected resources. The identity is managed by the Azure platform and does not require you to provide credentials within Control-M. Use this option if the Agent is installed on an Azure virtual machine that has an assigned Managed Identity with the required permissions.

    Managed Identity authentication is based on an Azure token that is valid, by default, for 24 hours. Token lifetime can be extended by Azure.

  • Service Principal: An Azure service principal, also known as App Registration, is an identity created for use with applications, hosted services, and automated tools to access Azure resources. This access is restricted by the roles assigned to the service principal, which gives the Azure Administrator control over which resources can be accessed and at which level. Use this option if the Agent is installed on-premises or any other cloud vendor.

    To prepare for authentication using a service principal, grant your service principal access to your Synapse workspace through the Synapse Studio (Manage > Access Control).

To prepare for authentication using each of these methods:

  • Grant your Managed Identity or service principal access to your Synapse workspace through the Synapse Studio (Manage > Access Control).

  • Assign a Contributor role to the Synapse workspace accessed by the Managed Identity or service principal.
Client ID of Managed Identity (Managed Identity) Defines the client ID for your Managed Identity.

Azure AD url

(Service Principal) Defines the Azure AD authentication endpoint base URL.

Example: https://login.microsoftonline.com

Tenant ID

(Service Principal) Defines the Tenant ID in Azure AD.

App ID

Defines the application (service principal) ID of the registered application for the Azure Synapse service.

Client Secret

(Service Principal) Defines the secret (password) associated with the Azure user and the application.
Synapse url

Defines the workspace development endpoint.

Example: https://myworkspace.dev.azuresynapse.net
Synapse Resource

Defines the resource parameter that serves as the identifier for Azure Synapse login via Azure AD:

https://dev.azuresynapse.net/

Connection Timeout

Defines a timeout value, in seconds, for the trigger call made by Control-M to Azure Synapse Analytics.

Default: 50 seconds.