Microsoft.DataFactory factories/triggers 2018-06-01

Article
12/09/2024

Bicep resource definition

The factories/triggers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.DataFactory/factories/triggers@2018-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    annotations: [
      any(Azure.Bicep.Types.Concrete.AnyType)
    ]
    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:

{
  pipelines: [
    {
      parameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'string'
      }
    }
  ]
  type: 'BlobEventsTrigger'
  typeProperties: {
    blobPathBeginsWith: 'string'
    blobPathEndsWith: 'string'
    events: [
      'string'
    ]
    ignoreEmptyBlobs: bool
    scope: 'string'
  }
}

For BlobTrigger, use:

{
  pipelines: [
    {
      parameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'string'
      }
    }
  ]
  type: 'BlobTrigger'
  typeProperties: {
    folderPath: 'string'
    linkedService: {
      parameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      referenceName: 'string'
      type: 'string'
    }
    maxConcurrency: int
  }
}

For ChainingTrigger, use:

{
  pipeline: {
    parameters: {
      {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    pipelineReference: {
      name: 'string'
      referenceName: 'string'
      type: 'string'
    }
  }
  type: 'ChainingTrigger'
  typeProperties: {
    dependsOn: [
      {
        name: 'string'
        referenceName: 'string'
        type: 'string'
      }
    ]
    runDimension: 'string'
  }
}

For CustomEventsTrigger, use:

{
  pipelines: [
    {
      parameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'string'
      }
    }
  ]
  type: 'CustomEventsTrigger'
  typeProperties: {
    events: [
      any(Azure.Bicep.Types.Concrete.AnyType)
    ]
    scope: 'string'
    subjectBeginsWith: 'string'
    subjectEndsWith: 'string'
  }
}

For ScheduleTrigger, use:

{
  pipelines: [
    {
      parameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'string'
      }
    }
  ]
  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 RerunTumblingWindowTrigger, use:

{
  type: 'RerunTumblingWindowTrigger'
  typeProperties: {
    parentTrigger: any(Azure.Bicep.Types.Concrete.AnyType)
    requestedEndTime: 'string'
    requestedStartTime: 'string'
    rerunConcurrency: int
  }
}

For TumblingWindowTrigger, use:

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

DependencyReference objects

Set the type property to specify the type of object.

For SelfDependencyTumblingWindowTriggerReference, use:

{
  offset: 'string'
  size: 'string'
  type: 'SelfDependencyTumblingWindowTriggerReference'
}

For TumblingWindowTriggerDependencyReference, use:

{
  offset: 'string'
  referenceTrigger: {
    referenceName: 'string'
    type: 'string'
  }
  size: 'string'
  type: 'TumblingWindowTriggerDependencyReference'
}

Property values

BlobEventsTrigger

Name	Description	Value
pipelines	Pipelines that need to be started.	TriggerPipelineReference[]
type	Trigger type.	'BlobEventsTrigger' (required)
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	The type of events that cause this trigger to fire.	String array containing any of: 'Microsoft.Storage.BlobCreated' 'Microsoft.Storage.BlobDeleted' (required)
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
pipelines	Pipelines that need to be started.	TriggerPipelineReference[]
type	Trigger type.	'BlobTrigger' (required)
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	The Azure Storage linked service reference.	LinkedServiceReference (required)
maxConcurrency	The max number of parallel files to handle when it is triggered.	int (required)

ChainingTrigger

Name	Description	Value
pipeline	Pipeline for which runs are created when all upstream pipelines complete successfully.	TriggerPipelineReference (required)
type	Trigger type.	'ChainingTrigger' (required)
typeProperties	Chaining Trigger properties.	ChainingTriggerTypeProperties (required)

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
pipelines	Pipelines that need to be started.	TriggerPipelineReference[]
type	Trigger type.	'CustomEventsTrigger' (required)
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

DependencyReference

Name	Description	Value
type	Set to 'SelfDependencyTumblingWindowTriggerReference' for type SelfDependencyTumblingWindowTriggerReference. Set to 'TumblingWindowTriggerDependencyReference' for type TumblingWindowTriggerDependencyReference.	'SelfDependencyTumblingWindowTriggerReference' 'TumblingWindowTriggerDependencyReference' (required)

LinkedServiceReference

Name	Description	Value
parameters	Arguments for LinkedService.	ParameterValueSpecification
referenceName	Reference LinkedService name.	string (required)
type	Linked service reference type.	'LinkedServiceReference' (required)