Append Variable activity in Azure Data Factory and Synapse Analytics

APPLIES TO: Azure Data Factory Azure Synapse Analytics

Tip

Try out Data Factory in Microsoft Fabric, an all-in-one analytics solution for enterprises. Microsoft Fabric covers everything from data movement to data science, real-time analytics, business intelligence, and reporting. Learn how to start a new trial for free!

Use the Append Variable activity to add a value to an existing array variable defined in a Data Factory or Synapse Analytics pipeline.

Create an Append Variable activity with UI

To use a Append Variable activity in a pipeline, complete the following steps:

  1. Select the background of the pipeline canvas and use the Variables tab to add an array type variable:

    Shows an empty pipeline canvas with the Variables tab selected having an array type variable named TestVariable.

  2. Search for Append Variable in the pipeline Activities pane, and drag an Append Variable activity to the pipeline canvas.

  3. Select the Append Variable activity on the canvas if it is not already selected, and its Variables tab, to edit its details.

  4. Select the variable for the Name property.

  5. Enter an expression for the value, which will be appended to the array in the variable. This can be a literal string expression, or any combination of dynamic expressions, functions, system variables, or outputs from other activities.

    Shows the UI for an Append Variable activity.

Note

The appended variable value does not appear in debug output unless you use a Set Variable activity to explicitly set a new variable with its value.

Type properties

Property Description Required
Name Name of the activity in pipeline Yes
Description Text describing what the activity does No
Type Activity Type is AppendVariable Yes
Value String literal or expression object value used to append into specified variable Yes
VariableName Name of the variable that will be modified by activity, the variable must be of type ‘Array’ Yes

Learn about a related control flow activity: