Microsoft.DataFactory factories/triggers

The factories/triggers resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DataFactory/factories/triggers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DataFactory/factories/triggers@2018-06-01' = {
  name: 'string'
  properties: {
    annotations: [ any ]
    description: 'string'
    type: 'string'
    // For remaining properties, see Trigger objects
  }
}

Trigger objects

Set the type property to specify the type of object.

For BlobEventsTrigger, use:

  type: 'BlobEventsTrigger'
  typeProperties: {
    blobPathBeginsWith: 'string'
    blobPathEndsWith: 'string'
    events: [ 'string' ]
    ignoreEmptyBlobs: bool
    scope: 'string'
  }

For BlobTrigger, use:

  type: 'BlobTrigger'
  typeProperties: {
    folderPath: 'string'
    linkedService: {
      parameters: {}
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    maxConcurrency: int
  }

For ChainingTrigger, use:

  type: 'ChainingTrigger'
  pipeline: {
    parameters: {}
    pipelineReference: {
      name: 'string'
      referenceName: 'string'
      type: 'PipelineReference'
    }
  }
  typeProperties: {
    dependsOn: [
      {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    ]
    runDimension: 'string'
  }

For CustomEventsTrigger, use:

  type: 'CustomEventsTrigger'
  typeProperties: {
    events: [ any ]
    scope: 'string'
    subjectBeginsWith: 'string'
    subjectEndsWith: 'string'
  }

For RerunTumblingWindowTrigger, use:

  type: 'RerunTumblingWindowTrigger'
  typeProperties: {
    parentTrigger: any()
    requestedEndTime: 'string'
    requestedStartTime: 'string'
    rerunConcurrency: int
  }

For ScheduleTrigger, use:

  type: 'ScheduleTrigger'
  typeProperties: {
    recurrence: {
      endTime: 'string'
      frequency: 'string'
      interval: int
      schedule: {
        hours: [ int ]
        minutes: [ int ]
        monthDays: [ int ]
        monthlyOccurrences: [
          {
            day: 'string'
            occurrence: int
          }
        ]
        weekDays: [ 'string' ]
      }
      startTime: 'string'
      timeZone: 'string'
    }
  }

For TumblingWindowTrigger, use:

  type: 'TumblingWindowTrigger'
  pipeline: {
    parameters: {}
    pipelineReference: {
      name: 'string'
      referenceName: 'string'
      type: 'PipelineReference'
    }
  }
  typeProperties: {
    delay: any()
    dependsOn: [
      {
        type: 'string'
        // For remaining properties, see DependencyReference objects
      }
    ]
    endTime: 'string'
    frequency: 'string'
    interval: int
    maxConcurrency: int
    retryPolicy: {
      count: any()
      intervalInSeconds: int
    }
    startTime: 'string'
  }

DependencyReference objects

Set the type property to specify the type of object.

For SelfDependencyTumblingWindowTriggerReference, use:

  type: 'SelfDependencyTumblingWindowTriggerReference'
  offset: 'string'
  size: 'string'

For TumblingWindowTriggerDependencyReference, use:

  type: 'TumblingWindowTriggerDependencyReference'
  offset: 'string'
  size: 'string'

Property values

factories/triggers

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DataFactory/factories/triggers'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-06-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Azure data factory nested object which contains information about creating pipeline run Trigger (required)

Trigger

Name Description Value
annotations List of tags that can be used for describing the trigger. any[]
description Trigger description. string
type Set the object type BlobEventsTrigger
BlobTrigger
ChainingTrigger
CustomEventsTrigger
RerunTumblingWindowTrigger
ScheduleTrigger
TumblingWindowTrigger

BlobEventsTrigger

Name Description Value
type Trigger type. 'BlobEventsTrigger'
typeProperties Blob Events Trigger properties. BlobEventsTriggerTypeProperties (required)

BlobEventsTriggerTypeProperties

Name Description Value
blobPathBeginsWith The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. string
blobPathEndsWith The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. string
events Blob event types. String array containing any of:
'Microsoft.Storage.BlobCreated'
'Microsoft.Storage.BlobDeleted'
ignoreEmptyBlobs If set to true, blobs with zero bytes will be ignored. bool
scope The ARM resource ID of the Storage Account. string (required)

BlobTrigger

Name Description Value
type Trigger type. 'BlobTrigger'
typeProperties Blob Trigger properties. BlobTriggerTypeProperties (required)

BlobTriggerTypeProperties

Name Description Value
folderPath The path of the container/folder that will trigger the pipeline. string (required)
linkedService Linked service reference type. LinkedServiceReference (required)
maxConcurrency The max number of parallel files to handle when it is triggered. int (required)

LinkedServiceReference

Name Description Value
parameters An object mapping parameter names to argument values. object
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference'

ChainingTrigger

Name Description Value
type Trigger type. 'ChainingTrigger'
pipeline Pipeline that needs to be triggered with the given parameters. TriggerPipelineReference (required)
typeProperties Chaining Trigger properties. ChainingTriggerTypeProperties (required)

TriggerPipelineReference

Name Description Value
parameters An object mapping parameter names to argument values. object
pipelineReference Pipeline reference type. PipelineReference

PipelineReference

Name Description Value
name Reference name. string
referenceName Reference pipeline name. string (required)
type Pipeline reference type. 'PipelineReference'

ChainingTriggerTypeProperties

Name Description Value
dependsOn Upstream Pipelines. PipelineReference[] (required)
runDimension Run Dimension property that needs to be emitted by upstream pipelines. string (required)

CustomEventsTrigger

Name Description Value
type Trigger type. 'CustomEventsTrigger'
typeProperties Custom Events Trigger properties. CustomEventsTriggerTypeProperties (required)

CustomEventsTriggerTypeProperties

Name Description Value
events The list of event types that cause this trigger to fire. any[] (required)
scope The ARM resource ID of the Azure Event Grid Topic. string (required)
subjectBeginsWith The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. string
subjectEndsWith The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. string

RerunTumblingWindowTrigger

Name Description Value
type Trigger type. 'RerunTumblingWindowTrigger'
typeProperties Rerun Trigger properties. RerunTumblingWindowTriggerTypeProperties (required)

RerunTumblingWindowTriggerTypeProperties

Name Description Value
parentTrigger Any object For Bicep, you can use the any() function.(required)
requestedEndTime The end time for the time period for which restatement is initiated. Only UTC time is currently supported. string (required)
requestedStartTime The start time for the time period for which restatement is initiated. Only UTC time is currently supported. string (required)
rerunConcurrency The max number of parallel time windows (ready for execution) for which a rerun is triggered. int (required)

ScheduleTrigger

Name Description Value
type Trigger type. 'ScheduleTrigger'
typeProperties Schedule Trigger properties. ScheduleTriggerTypeProperties (required)

ScheduleTriggerTypeProperties

Name Description Value
recurrence The workflow trigger recurrence. ScheduleTriggerRecurrence (required)

ScheduleTriggerRecurrence

Name Description Value
endTime The end time. string
frequency Enumerates possible frequency option for the schedule trigger. 'Day'
'Hour'
'Minute'
'Month'
'NotSpecified'
'Week'
'Year'
interval The interval. int
schedule The recurrence schedule. RecurrenceSchedule
startTime The start time. string
timeZone The time zone. string

RecurrenceSchedule

Name Description Value
hours The hours. int[]
minutes The minutes. int[]
monthDays The month days. int[]
monthlyOccurrences The monthly occurrences. RecurrenceScheduleOccurrence[]
weekDays The days of the week. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'

RecurrenceScheduleOccurrence

Name Description Value
day The days of the week. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
occurrence The occurrence. int

TumblingWindowTrigger

Name Description Value
type Trigger type. 'TumblingWindowTrigger'
pipeline Pipeline that needs to be triggered with the given parameters. TriggerPipelineReference (required)
typeProperties Tumbling Window Trigger properties. TumblingWindowTriggerTypeProperties (required)

TumblingWindowTriggerTypeProperties

Name Description Value
delay Any object For Bicep, you can use the any() function.
dependsOn Triggers that this trigger depends on. Only tumbling window triggers are supported. DependencyReference[]
endTime The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported. string
frequency Enumerates possible frequency option for the tumbling window trigger. 'Hour'
'Minute'
'Month'
interval The interval of the time windows. The minimum interval allowed is 15 Minutes. int (required)
maxConcurrency The max number of parallel time windows (ready for execution) for which a new run is triggered. int (required)
retryPolicy Execution policy for an activity. RetryPolicy
startTime The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported. string (required)

DependencyReference

Name Description Value
type Set the object type SelfDependencyTumblingWindowTriggerReference
TumblingWindowTriggerDependencyReference

SelfDependencyTumblingWindowTriggerReference

Name Description Value
type The type of dependency reference. 'SelfDependencyTumblingWindowTriggerReference'
offset Timespan applied to the start time of a tumbling window when evaluating dependency. string (required)
size The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. string

TumblingWindowTriggerDependencyReference

Name Description Value
type The type of dependency reference. 'TumblingWindowTriggerDependencyReference'
offset Timespan applied to the start time of a tumbling window when evaluating dependency. string
size The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. string

RetryPolicy

Name Description Value
count Any object For Bicep, you can use the any() function.
intervalInSeconds Interval between retries in seconds. Default is 30. int