Skip to content

Latest commit

 

History

History
51 lines (43 loc) · 2.97 KB

control-flow-system-variables.md

File metadata and controls

51 lines (43 loc) · 2.97 KB
title description services documentationcenter author manager ms.reviewer ms.service ms.workload ms.tgt_pltfrm ms.devlang ms.topic ms.date ms.author
System variables in Azure Data Factory | Microsoft Docs
This article describes system variables supported by Azure Data Factory. You can use these variables in expressions when defining Data Factory entities.
data-factory
sharonlo101
craigg
douglasl
data-factory
data-services
na
na
conceptual
06/12/2018
shlo

System variables supported by Azure Data Factory

This article describes system variables supported by Azure Data Factory. You can use these variables in expressions when defining Data Factory entities.

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.9935483Z respectively.

Tumbling Window Trigger scope

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

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.