Azure Synapse Pipeline

The Azure Synapse Pipeline activity triggers a pipeline in Azure Synapse Analytics and waits for it to complete before the workflow continues.

Prerequisites

An Azure Synapse data source must be configured in Una with:

Tenant ID
Client ID and authentication key (service principal credentials)
Development endpoint URL (e.g. https://<workspace>.dev.azuresynapse.net)

Configuration

Data Source

Select the Azure Synapse data source. Only data sources of type Azure Synapse are available.

Pipeline Name

The name of the Synapse pipeline to run. Supports interpolation:

Transform_{{var:Period}}

Parameters

Key/value pairs passed to the Synapse pipeline as runtime parameters. Both key and value support interpolation.

Behavior

The pipeline name and all parameter values are interpolated.
A service principal credential is created using the data source configuration.
The pipeline is triggered via the Synapse Artifacts SDK.
The activity polls for run status using incremental wait intervals until the status is no longer InProgress or Queued.
Returns Success when the pipeline exits its running state.

Similar to Azure DataFactory, the activity does not currently distinguish between Synapse pipeline success and failure in its return status. Check Synapse Studio run history if downstream steps indicate a problem.

Usage Patterns

Synapse Transform Then Load

Azure Synapse Pipeline ──> Remote Data Load ──> ETL
  └── Pipeline: PrepareStaging
      Parameters: Period = {{var:Period}}

Best Practices

Use service principal credentials, not user-based authentication, for long-lived data source configurations.
Add a downstream row-count or validation check if the Synapse pipeline outcome must be verified before continuing.

JSON Reference

{
  "discriminator": "AzureSynapseWorkflowActivity",
  "activityId": "<uuid>",
  "name": "Synapse Pipeline",
  "positionX": 0,
  "positionY": 0,
  "advanceRule": 2,
  "dataSource": "MySynapseConnection",
  "pipelineName": "Transform_{Period}",
  "parameters": [
    { "key": "Period", "value": "{Period}" }
  ]
}

Property	Type	Description
`dataSource`	string	Corresponds to the Data Source field. The Azure Synapse data source.
`pipelineName`	string	Corresponds to the Pipeline Name field. The name of the Synapse pipeline to trigger. Supports `{variable}` interpolation.
`parameters`	array	Corresponds to the Parameters list. Array of `{ "key": string, "value": string }` objects passed as Synapse pipeline runtime parameters.

Prerequisites​

Configuration​

Data Source​

Pipeline Name​

Parameters​

Behavior​

Usage Patterns​

Synapse Transform Then Load​

Best Practices​

JSON Reference​