Microsoft.DataFactory factories/triggers 2017-09-01-preview

  • Article

Bicep resource definition

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

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@2017-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see Trigger objects
  }
}

Trigger objects

Set the type property to specify the type of object.

For MultiplePipelineTrigger, use:

  type: 'MultiplePipelineTrigger'
  pipelines: [
    {
      parameters: {
        {customized property}: any()
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    }
  ]

Property values

factories/triggers

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/ or control characters

Start with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: factories
properties Properties of the trigger. Trigger (required)

Trigger

Name Description Value
description Trigger description. string
type Set the object type MultiplePipelineTrigger (required)

MultiplePipelineTrigger

Name Description Value
type Trigger type. 'MultiplePipelineTrigger' (required)
pipelines Pipelines that need to be started. TriggerPipelineReference[]

TriggerPipelineReference

Name Description Value
parameters Pipeline parameters. ParameterValueSpecification
pipelineReference Pipeline reference. PipelineReference

ParameterValueSpecification

Name Description Value
{customized property} For Bicep, you can use the any() function.

PipelineReference

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

ARM template resource definition

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

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 JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/triggers",
  "apiVersion": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see Trigger objects
  }
}

Trigger objects

Set the type property to specify the type of object.

For MultiplePipelineTrigger, use:

  "type": "MultiplePipelineTrigger",
  "pipelines": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "pipelineReference": {
        "name": "string",
        "referenceName": "string",
        "type": "PipelineReference"
      }
    }
  ]

Property values

factories/triggers

Name Description Value
type The resource type 'Microsoft.DataFactory/factories/triggers'
apiVersion The resource api version '2017-09-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/ or control characters

Start with alphanumeric.
properties Properties of the trigger. Trigger (required)

Trigger

Name Description Value
description Trigger description. string
type Set the object type MultiplePipelineTrigger (required)

MultiplePipelineTrigger

Name Description Value
type Trigger type. 'MultiplePipelineTrigger' (required)
pipelines Pipelines that need to be started. TriggerPipelineReference[]

TriggerPipelineReference

Name Description Value
parameters Pipeline parameters. ParameterValueSpecification
pipelineReference Pipeline reference. PipelineReference

ParameterValueSpecification

Name Description Value
{customized property}

PipelineReference

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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/triggers@2017-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see Trigger objects
    }
  })
}

Trigger objects

Set the type property to specify the type of object.

For MultiplePipelineTrigger, use:

  type = "MultiplePipelineTrigger"
  pipelines = [
    {
      parameters = {}
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "PipelineReference"
      }
    }
  ]

Property values

factories/triggers

Name Description Value
type The resource type "Microsoft.DataFactory/factories/triggers@2017-09-01-preview"
name The resource name string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/ or control characters

Start with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: factories
properties Properties of the trigger. Trigger (required)

Trigger

Name Description Value
description Trigger description. string
type Set the object type MultiplePipelineTrigger (required)

MultiplePipelineTrigger

Name Description Value
type Trigger type. "MultiplePipelineTrigger" (required)
pipelines Pipelines that need to be started. TriggerPipelineReference[]

TriggerPipelineReference

Name Description Value
parameters Pipeline parameters. ParameterValueSpecification
pipelineReference Pipeline reference. PipelineReference

ParameterValueSpecification

Name Description Value
{customized property}

PipelineReference

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