0% found this document useful (0 votes)
87 views

System Variables Supported by Azure Data Factory

This document describes system variables that can be referenced in Azure Data Factory pipelines and triggers. It provides a table listing the variable name, description, and scope for pipeline variables like @pipeline().DataFactory and @pipeline().RunId. It also describes schedule trigger variables like @trigger().scheduledTime and @trigger().startTime. Finally, it lists tumbling window trigger variables like @trigger().outputs.windowStartTime and @trigger().outputs.windowEndTime that provide the start and end time of the trigger window.

Uploaded by

lfc
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
87 views

System Variables Supported by Azure Data Factory

This document describes system variables that can be referenced in Azure Data Factory pipelines and triggers. It provides a table listing the variable name, description, and scope for pipeline variables like @pipeline().DataFactory and @pipeline().RunId. It also describes schedule trigger variables like @trigger().scheduledTime and @trigger().startTime. Finally, it lists tumbling window trigger variables like @trigger().outputs.windowStartTime and @trigger().outputs.windowEndTime that provide the start and end time of the trigger window.

Uploaded by

lfc
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

System variables supported by Azure Data

Factory
Pipeline scope
These system variables can be referenced anywhere in the pipeline JSON.

Variable Name Description

@pipeline().DataFactory Name of the data factory the pipeline run is running within

@pipeline().Pipeline Name of the pipeline

@pipeline().RunId ID of the specific pipeline run

@pipeline().TriggerType Type of the trigger that invoked the pipeline (Manual, Scheduler)

@pipeline().TriggerId ID of the trigger that invokes the pipeline

@pipeline().TriggerName Name of the trigger that invokes the pipeline

@pipeline().TriggerTime Time when the trigger that invoked the pipeline. The trigger time is the actual fired
time, not the scheduled time. For example, 13:20:08.0149599Z is returned instead
of 13:20:00.00Z

Schedule Trigger scope


These system variables can be referenced anywhere in the trigger JSON if the trigger is of type:
"ScheduleTrigger."

Variable Name Description

@trigger().scheduledTime Time when the trigger was scheduled to invoke the pipeline run. For example, for
a trigger that fires every 5 min, this variable would return 2017-06-
01T22:20:00Z, 2017-06-01T22:25:00Z, 2017-06-01T22:29:00Z respectively.

@trigger().startTime Time when the trigger actually fired to invoke the pipeline run. For example, for a
trigger that fires every 5 min, this variable might return something like this 2017-
06-01T22:20:00.4061448Z, 2017-06-01T22:25:00.7958577Z, 2017-06-
01T22:29:00.9935483Zrespectively. (Note: The timestamp is by default in ISO
8601 format)

Tumbling Window Trigger scope


These system variables can be referenced anywhere in the trigger JSON if the trigger is of type:
"TumblingWindowTrigger." (Note: The timestamp is by default in ISO 8601 format)

Variable Name Description

@trigger().outputs.windowStartTime Start of the window when the trigger was scheduled to invoke the
pipeline run. If the tumbling window trigger has a frequency of "hourly"
this would be the time at the beginning of the hour.

@trigger().outputs.windowEndTime End of the window when the trigger was scheduled to invoke the
pipeline run. If the tumbling window trigger has a frequency of "hourly"
this would be the time at the end of the hour.

Next steps
For information about how these variables are used in expressions, see Expression language &
functions.

You might also like