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

• Latest
• 2018-06-01
• 2017-09-01-preview

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@2017-09-01-preview' = {
  parent: resourceSymbolicName
  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:

{
  pipelines: [
    {
      parameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'string'
      }
    }
  ]
  type: 'MultiplePipelineTrigger'
}

Property values

Microsoft.DataFactory/factories/triggers

Name	Description	Value
name	The resource name	string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
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)

MultiplePipelineTrigger

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

ParameterValueSpecification

Name	Description	Value

PipelineReference

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

Trigger

Name	Description	Value
description	Trigger description.	string
type	Set to 'MultiplePipelineTrigger' for type MultiplePipelineTrigger.	'MultiplePipelineTrigger' (required)

TriggerPipelineReference

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

ARM template 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 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:

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

Property values

Microsoft.DataFactory/factories/triggers

Name	Description	Value
apiVersion	The api version	'2017-09-01-preview'
name	The resource name	string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
properties	Properties of the trigger.	Trigger (required)
type	The resource type	'Microsoft.DataFactory/factories/triggers'

MultiplePipelineTrigger

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

ParameterValueSpecification

Name	Description	Value

PipelineReference

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

Trigger

Name	Description	Value
description	Trigger description.	string
type	Set to 'MultiplePipelineTrigger' for type MultiplePipelineTrigger.	'MultiplePipelineTrigger' (required)

TriggerPipelineReference

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

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"
  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:

{
  pipelines = [
    {
      parameters = {
        {customized property} = ?
      }
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "string"
      }
    }
  ]
  type = "MultiplePipelineTrigger"
}

Property values

Microsoft.DataFactory/factories/triggers

Name	Description	Value
name	The resource name	string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
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)
type	The resource type	"Microsoft.DataFactory/factories/triggers@2017-09-01-preview"

MultiplePipelineTrigger

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

ParameterValueSpecification

Name	Description	Value

PipelineReference

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

Trigger

Name	Description	Value
description	Trigger description.	string
type	Set to 'MultiplePipelineTrigger' for type MultiplePipelineTrigger.	'MultiplePipelineTrigger' (required)

TriggerPipelineReference

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