你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DataFactory factories/triggers 2018-06-01

  • 项目

Bicep 资源定义

工厂/触发器资源类型可以通过针对以下操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DataFactory/factories/triggers 资源，请将以下 Bicep 添加到模板。

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

触发对象

设置 type 属性以指定对象的类型。

对于 BlobEventsTrigger，请使用：

  type: 'BlobEventsTrigger'
  pipelines: [
    {
      parameters: {
        {customized property}: any()
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    }
  ]
  typeProperties: {
    blobPathBeginsWith: 'string'
    blobPathEndsWith: 'string'
    events: [
      'string'
    ]
    ignoreEmptyBlobs: bool
    scope: 'string'
  }

对于 BlobTrigger，请使用：

  type: 'BlobTrigger'
  pipelines: [
    {
      parameters: {
        {customized property}: any()
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    }
  ]
  typeProperties: {
    folderPath: 'string'
    linkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    maxConcurrency: int
  }

对于 ChainingTrigger，请使用：

  type: 'ChainingTrigger'
  pipeline: {
    parameters: {
      {customized property}: any()
    }
    pipelineReference: {
      name: 'string'
      referenceName: 'string'
      type: 'PipelineReference'
    }
  }
  typeProperties: {
    dependsOn: [
      {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    ]
    runDimension: 'string'
  }

对于 CustomEventsTrigger，请使用：

  type: 'CustomEventsTrigger'
  pipelines: [
    {
      parameters: {
        {customized property}: any()
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    }
  ]
  typeProperties: {
    events: [
      any
    ]
    scope: 'string'
    subjectBeginsWith: 'string'
    subjectEndsWith: 'string'
  }

对于 RerunTumblingWindowTrigger，请使用：

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

对于 ScheduleTrigger，请使用：

  type: 'ScheduleTrigger'
  pipelines: [
    {
      parameters: {
        {customized property}: any()
      }
      pipelineReference: {
        name: 'string'
        referenceName: 'string'
        type: 'PipelineReference'
      }
    }
  ]
  typeProperties: {
    recurrence: {
      endTime: 'string'
      frequency: 'string'
      interval: int
      schedule: {
        hours: [
          int
        ]
        minutes: [
          int
        ]
        monthDays: [
          int
        ]
        monthlyOccurrences: [
          {
            day: 'string'
            occurrence: int
            {customized property}: any()
          }
        ]
        weekDays: [
          'string'
        ]
        {customized property}: any()
      }
      startTime: 'string'
      timeZone: 'string'
      {customized property}: any()
    }
  }

对于 TumblingWindowTrigger，请使用：

  type: 'TumblingWindowTrigger'
  pipeline: {
    parameters: {
      {customized property}: any()
    }
    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 对象

设置 type 属性以指定对象的类型。

对于 SelfDependencyTumblingWindowTriggerReference，请使用：

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

对于 TumblingWindowTriggerDependencyReference，请使用：

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

属性值

factories/triggers

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-260

有效字符：
不得使用：
<>*#.%&:\\+?/ 或控制字符

以字母数字开头。
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为“工厂”的资源的符号名称
properties 触发器的属性。 触发 (必需)

触发器

名称 说明 值
annotations 可用于描述触发器的标记列表。 any[]
description 触发器说明。 字符串
type 设置对象类型 BlobEventsTrigger
BlobTrigger
ChainingTrigger
CustomEventsTrigger
重新运行TumblingWindowTrigger
ScheduleTrigger
需要 TumblingWindowTrigger ()

BlobEventsTrigger

名称 说明 Value
type 触发器类型。 “BlobEventsTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties Blob 事件触发器属性。 BlobEventsTriggerTypeProperties (必需)

TriggerPipelineReference

名称 说明 值
parameters 管道参数。 ParameterValueSpecification
pipelineReference 管道引用。 PipelineReference

ParameterValueSpecification

名称 说明 值
{customized property} 对于 Bicep，可以使用 任何 () 函数。

PipelineReference

名称 说明 值
name 引用名称。 字符串
referenceName 引用管道名称。 字符串 (必需)
类型 管道引用类型。 “PipelineReference” (必需的)

BlobEventsTriggerTypeProperties

名称 说明 值
blobPathBeginsWith Blob 路径必须使用为要触发的触发器提供的模式开头。 例如，“/records/blobs/december/”将仅针对 records 容器下的 december 文件夹中的 blob 使触发器触发。 必须至少提供其中一个：blobPathBeginsWith、blobPathEndsWith。 字符串
blobPathEndsWith Blob 路径必须使用为要触发的触发器提供的模式结尾。 例如，“december/boxes.csv”将仅针对 december 文件夹中名为 boxes 的 blob 使触发器触发。 必须至少提供其中一个：blobPathBeginsWith、blobPathEndsWith。 字符串
活动 导致此触发器触发的事件的类型。 包含任意项的字符串数组：
“Microsoft.Storage.BlobCreated”
需要“Microsoft.Storage.BlobDeleted” ()
ignoreEmptyBlobs 如果设置为 true，则将忽略包含零字节的 Blob。 bool
scope 存储帐户的 ARM 资源 ID。 字符串 (必需)

BlobTrigger

名称 说明 Value
type 触发器类型。 “BlobTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties Blob 触发器属性。 BlobTriggerTypeProperties (必需)

BlobTriggerTypeProperties

名称 说明 值
folderPath 将触发管道的容器/文件夹的路径。 字符串 (必需)
linkedService Azure 存储链接服务引用。 LinkedServiceReference (必需)
maxConcurrency 触发时要处理的并行文件的最大数量。 int (必需)

LinkedServiceReference

名称 说明 值
parameters LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 字符串 (必需)
类型 链接服务引用类型。 “LinkedServiceReference” (必需)

ChainingTrigger

名称 说明 Value
type 触发器类型。 需要“ChainingTrigger” ()
管道 当所有上游管道成功完成时，将为其创建运行。 TriggerPipelineReference (必需)
typeProperties 链接触发器属性。 ChainingTriggerTypeProperties (必需)

ChainingTriggerTypeProperties

名称 说明 值
dependsOn 上游管道。 PipelineReference[] (必需的)
runDimension 运行需要由上游管道发出的 Dimension 属性。 字符串 (必需)

CustomEventsTrigger

名称 说明 Value
type 触发器类型。 “CustomEventsTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties 自定义事件触发器属性。 CustomEventsTriggerTypeProperties (必需)

CustomEventsTriggerTypeProperties

名称 说明 值
活动 导致此触发器触发的事件类型的列表。 any[] (必需)
scope Azure 事件网格主题的 ARM 资源 ID。 字符串 (必需)
subjectBeginsWith 事件主题必须以为触发器触发提供的模式开头。 必须至少提供其中一个：subjectBeginsWith、subjectEndsWith。 字符串
subjectEndsWith 事件主题必须以为触发器触发提供的模式结束。 必须至少提供其中一个：subjectBeginsWith、subjectEndsWith。 字符串

RerunTumblingWindowTrigger

名称 说明 Value
type 触发器类型。 需要“RerunTumblingWindowTrigger” ()
typeProperties 重新运行触发器属性。 需要重新运行TumblingWindowTriggerTypeProperties ()

RerunTumblingWindowTriggerTypeProperties

名称 说明 值
parentTrigger 父触发器引用。 对于 Bicep，可以使用 所需的任何 () function. ()
requestedEndTime 启动重述的时间段的结束时间。 目前仅支持 UTC 时间。 字符串 (必需)
requestedStartTime 启动重述的时间段的开始时间。 目前仅支持 UTC 时间。 字符串 (必需)
rerunConcurrency 已触发重新运行的) ， (准备执行的最大并行时间窗口数。 int (必需)

约束：
最小值 = 1
最大值 = 50

ScheduleTrigger

名称 说明 Value
type 触发器类型。 需要“ScheduleTrigger” ()
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties 计划触发器属性。 ScheduleTriggerTypeProperties (必需)

ScheduleTriggerTypeProperties

名称 说明 值
recurrence 定期计划配置。 ScheduleTriggerRecurrence (必需)

ScheduleTriggerRecurrence

名称 说明 值
endTime 结束时间。 字符串
频率 频率。 “Day”
“Hour”
'Minute'
“Month”
“NotSpecified”
“Week”
“Year”
interval 间隔。 int
schedule 定期计划。 RecurrenceSchedule
startTime 开始时间。 字符串
timezone 时区。 字符串
{customized property} 对于 Bicep，可以使用 任何 () 函数。

RecurrenceSchedule

名称 说明 值
小时 小时。 int[]
分钟数 分钟数。 int[]
monthDays 月天数。 int[]
monthlyOccurrences 每月出现次数。 RecurrenceScheduleOccurrence[]
工作日 一周中的几天。 包含任意项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
{customized property} 对于 Bicep，可以使用 任何 () 函数。

RecurrenceScheduleOccurrence

名称 说明 值
day 星期几。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
occurrence 匹配项。 int
{customized property} 对于 Bicep，可以使用 任何 () 函数。

TumblingWindowTrigger

名称 说明 Value
type 触发器类型。 “TumblingWindowTrigger” (必需)
管道 当为已准备就绪的触发器窗口触发事件时，将为其创建运行的管道。 TriggerPipelineReference (必需)
typeProperties 翻转窗口触发器属性。 需要 TumblingWindowTriggerTypeProperties ()

TumblingWindowTriggerTypeProperties

名称 说明 值
delay 指定触发器在触发新运行之前等待超过到期时间的时长。 它不会更改窗口开始和结束时间。 默认值为 0。 类型：包含 resultType 字符串) 的字符串 (或表达式， pattern： ( (\d+) .) ？ (\d\d) ： (60， ([0-5][0-9]) ) ： (60， ([0-5][0-9]) ) 。 对于 Bicep，可以使用 任何 () 函数。
dependsOn 此触发器所依赖的触发器。 仅支持翻转窗口触发器。 DependencyReference[]
endTime 触发器的结束时间，在此期间，为已准备就绪的窗口触发事件。 目前仅支持 UTC 时间。 字符串
频率 时间窗口的频率。 “Hour”
“Minute”
“Month” (必需)
interval 时间窗口的间隔。 允许的最小间隔为 15 分钟。 int (必需)
maxConcurrency (为触发新运行的) 准备好执行的最大并行时间窗口数。 int (必需)

约束：
最小值 = 1
最大值 = 50
retryPolicy 将应用于失败管道运行的重试策略。 RetryPolicy
startTime 触发器的时间段的开始时间，在此期间，为已就绪的窗口触发事件。 目前仅支持 UTC 时间。 字符串 (必需)

DependencyReference

名称 说明 Value
type 设置对象类型 SelfDependencyTumblingWindowTriggerReference
TumblingWindowTriggerDependencyReference (所需的)

SelfDependencyTumblingWindowTriggerReference

名称 说明 Value
type 依赖项引用的类型。 “SelfDependencyTumblingWindowTriggerReference” (必需)
offset 评估依赖项时应用于翻转窗口开始时间的时间跨度。 字符串 (必需)

约束：
最小长度 = 8
最大长度 = 15
模式 = -((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))
大小 评估依赖项时窗口的大小。 如果未定义，将使用翻转窗口的频率。 字符串

约束：
最小长度 = 8
最大长度 = 15
模式 = ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))

TumblingWindowTriggerDependencyReference

名称 说明 Value
type 依赖项引用的类型。 需要“TumblingWindowTriggerDependencyReference” ()
offset 评估依赖项时应用于翻转窗口开始时间的时间跨度。 字符串

约束：
最小长度 = 8
最大长度 = 15
模式 = -?((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))
referenceTrigger 引用的触发器。 TriggerReference (必需)
大小 评估依赖项时窗口的大小。 如果未定义，将使用翻转窗口的频率。 字符串

约束：
最小长度 = 8
最大长度 = 15
模式 = ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))

TriggerReference

名称 说明 值
referenceName 引用触发器名称。 字符串 (必需)
类型 触发器引用类型。 “TriggerReference” (必需)

RetryPolicy

名称 说明 Value
count 最大普通重试尝试次数。 默认为 0。 类型：整数 (或 resultType 整数) 的表达式，最小值：0。 对于 Bicep，可以使用 任何 () 函数。
intervalInSeconds 重试间隔（以秒为单位）。 默认值为 30。 int

约束：
最小值 = 30
最大值 = 86400

ARM 模板资源定义

可以使用面向以下操作部署工厂/触发器资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DataFactory/factories/triggers 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DataFactory/factories/triggers",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "annotations": [ object ],
    "description": "string",
    "type": "string"
    // For remaining properties, see Trigger objects
  }
}

触发器对象

设置 type 属性以指定对象的类型。

对于 BlobEventsTrigger，请使用：

  "type": "BlobEventsTrigger",
  "pipelines": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "pipelineReference": {
        "name": "string",
        "referenceName": "string",
        "type": "PipelineReference"
      }
    }
  ],
  "typeProperties": {
    "blobPathBeginsWith": "string",
    "blobPathEndsWith": "string",
    "events": [ "string" ],
    "ignoreEmptyBlobs": "bool",
    "scope": "string"
  }

对于 BlobTrigger，请使用：

  "type": "BlobTrigger",
  "pipelines": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "pipelineReference": {
        "name": "string",
        "referenceName": "string",
        "type": "PipelineReference"
      }
    }
  ],
  "typeProperties": {
    "folderPath": "string",
    "linkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "maxConcurrency": "int"
  }

对于 ChainingTrigger，请使用：

  "type": "ChainingTrigger",
  "pipeline": {
    "parameters": {
      "{customized property}": {}
    },
    "pipelineReference": {
      "name": "string",
      "referenceName": "string",
      "type": "PipelineReference"
    }
  },
  "typeProperties": {
    "dependsOn": [
      {
        "name": "string",
        "referenceName": "string",
        "type": "PipelineReference"
      }
    ],
    "runDimension": "string"
  }

对于 CustomEventsTrigger，请使用：

  "type": "CustomEventsTrigger",
  "pipelines": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "pipelineReference": {
        "name": "string",
        "referenceName": "string",
        "type": "PipelineReference"
      }
    }
  ],
  "typeProperties": {
    "events": [ object ],
    "scope": "string",
    "subjectBeginsWith": "string",
    "subjectEndsWith": "string"
  }

对于 RerunTumblingWindowTrigger，请使用：

  "type": "RerunTumblingWindowTrigger",
  "typeProperties": {
    "parentTrigger": {},
    "requestedEndTime": "string",
    "requestedStartTime": "string",
    "rerunConcurrency": "int"
  }

对于 ScheduleTrigger，请使用：

  "type": "ScheduleTrigger",
  "pipelines": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "pipelineReference": {
        "name": "string",
        "referenceName": "string",
        "type": "PipelineReference"
      }
    }
  ],
  "typeProperties": {
    "recurrence": {
      "endTime": "string",
      "frequency": "string",
      "interval": "int",
      "schedule": {
        "hours": [ "int" ],
        "minutes": [ "int" ],
        "monthDays": [ "int" ],
        "monthlyOccurrences": [
          {
            "day": "string",
            "occurrence": "int",
            "{customized property}": {}
          }
        ],
        "weekDays": [ "string" ],
        "{customized property}": {}
      },
      "startTime": "string",
      "timeZone": "string",
      "{customized property}": {}
    }
  }

对于 TumblingWindowTrigger，请使用：

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

DependencyReference 对象

设置 type 属性以指定对象的类型。

对于 SelfDependencyTumblingWindowTriggerReference，请使用：

  "type": "SelfDependencyTumblingWindowTriggerReference",
  "offset": "string",
  "size": "string"

对于 TumblingWindowTriggerDependencyReference，请使用：

  "type": "TumblingWindowTriggerDependencyReference",
  "offset": "string",
  "referenceTrigger": {
    "referenceName": "string",
    "type": "TriggerReference"
  },
  "size": "string"

属性值

factories/triggers

名称 说明 Value
type 资源类型 'Microsoft.DataFactory/factories/triggers'
apiVersion 资源 API 版本 '2018-06-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-260

有效字符：
不得使用：
<>*#.%&:\\+?/ 或控制字符

以字母数字开头。
properties 触发器的属性。 触发 (必需)

触发器

名称 说明 值
annotations 可用于描述触发器的标记列表。 any[]
description 触发器说明。 字符串
type 设置对象类型 BlobEventsTrigger
BlobTrigger
ChainingTrigger
CustomEventsTrigger
重新运行TumblingWindowTrigger
ScheduleTrigger
需要 TumblingWindowTrigger ()

BlobEventsTrigger

名称 说明 Value
type 触发器类型。 “BlobEventsTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties Blob 事件触发器属性。 BlobEventsTriggerTypeProperties (必需)

TriggerPipelineReference

名称 说明 值
parameters 管道参数。 ParameterValueSpecification
pipelineReference 管道引用。 PipelineReference

ParameterValueSpecification

名称 说明 值
{customized property}

PipelineReference

名称 说明 值
name 引用名称。 字符串
referenceName 引用管道名称。 字符串 (必需)
类型 管道引用类型。 “PipelineReference” (必需的)

BlobEventsTriggerTypeProperties

名称 说明 值
blobPathBeginsWith Blob 路径必须使用为要触发的触发器提供的模式开头。 例如，“/records/blobs/december/”将仅针对 records 容器下的 december 文件夹中的 blob 使触发器触发。 必须至少提供其中一个：blobPathBeginsWith、blobPathEndsWith。 字符串
blobPathEndsWith Blob 路径必须使用为要触发的触发器提供的模式结尾。 例如，“december/boxes.csv”将仅针对 december 文件夹中名为 boxes 的 blob 使触发器触发。 必须至少提供其中一个：blobPathBeginsWith、blobPathEndsWith。 字符串
活动 导致此触发器触发的事件的类型。 包含任何一项的字符串数组：
'Microsoft.Storage.BlobCreated'
需要“Microsoft.Storage.BlobDeleted” ()
ignoreEmptyBlobs 如果设置为 true，则将忽略具有零字节的 Blob。 bool
scope 存储帐户的 ARM 资源 ID。 字符串 (必需)

BlobTrigger

名称 说明 Value
type 触发器类型。 需要“BlobTrigger” ()
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties Blob 触发器属性。 BlobTriggerTypeProperties (必需)

BlobTriggerTypeProperties

名称 说明 值
folderPath 将触发管道的容器/文件夹的路径。 字符串 (必需)
linkedService Azure 存储链接服务引用。 LinkedServiceReference (必需)
maxConcurrency 触发时要处理的并行文件的最大数目。 int (必需)

LinkedServiceReference

名称 说明 值
parameters LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 字符串 (必需)
类型 链接服务引用类型。 “LinkedServiceReference” (必需)

ChainingTrigger

名称 说明 Value
type 触发器类型。 需要“ChainingTrigger” ()
管道 当所有上游管道成功完成时，将为其创建运行的管道。 TriggerPipelineReference (必需)
typeProperties 链接触发器属性。 ChainingTriggerTypeProperties (必需)

ChainingTriggerTypeProperties

名称 说明 值
dependsOn 上游管道。 PipelineReference[] (必需)
runDimension 运行需要由上游管道发出的维度属性。 字符串 (必需)

CustomEventsTrigger

名称 说明 Value
type 触发器类型。 “CustomEventsTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties 自定义事件触发器属性。 CustomEventsTriggerTypeProperties (必需)

CustomEventsTriggerTypeProperties

名称 说明 值
活动 导致此触发器触发的事件类型的列表。 any[] (必需)
scope Azure 事件网格主题的 ARM 资源 ID。 字符串 (必需)
subjectBeginsWith 事件主题必须以为要触发的触发器提供的模式开头。 必须至少提供其中一个：subjectBeginsWith、subjectEndsWith。 字符串
subjectEndsWith 事件主题必须以为触发触发器提供的模式结束。 必须至少提供其中一个：subjectBeginsWith、subjectEndsWith。 字符串

重新运行TumblingWindowTrigger

名称 说明 Value
type 触发器类型。 需要“RerunTumblingWindowTrigger” ()
typeProperties 重新运行触发器属性。 需要重新运行TumblingWindowTriggerTypeProperties ()

RerunTumblingWindowTriggerTypeProperties

名称 说明 值
parentTrigger 父触发器引用。
requestedEndTime 启动重述的时间段的结束时间。 目前仅支持 UTC 时间。 字符串 (必需)
requestedStartTime 启动重述的时间段的开始时间。 目前仅支持 UTC 时间。 字符串 (必需)
rerunConcurrency (已准备好执行) 触发重新运行的最大并行时间窗口数。 int (必需)

约束：
最小值 = 1
最大值 = 50

ScheduleTrigger

名称 说明 Value
type 触发器类型。 “ScheduleTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties 计划触发器属性。 ScheduleTriggerTypeProperties (必需)

ScheduleTriggerTypeProperties

名称 说明 值
recurrence 定期计划配置。 ScheduleTriggerRecurrence (必需)

ScheduleTriggerRecurrence

名称 说明 值
endTime 结束时间。 字符串
频率 频率。 “Day”
“Hour”
“Minute”
“Month”
“NotSpecified”
“Week”
“Year”
interval 间隔。 int
schedule 定期计划。 RecurrenceSchedule
startTime 开始时间。 字符串
timezone 时区。 字符串
{customized property}

RecurrenceSchedule

名称 说明 值
小时 小时。 int[]
分钟数 分钟数。 int[]
monthDays 月天数。 int[]
monthlyOccurrences 每月出现次数。 RecurrenceScheduleOccurrence[]
工作日 一周中的几天。 包含任意项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
{customized property}

RecurrenceScheduleOccurrence

名称 说明 值
day 星期几。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“星期三”
occurrence 匹配项。 int
{customized property}

TumblingWindowTrigger

名称 说明 Value
type 触发器类型。 “TumblingWindowTrigger” (必需)
管道 当为已准备就绪的触发器窗口触发事件时，将为其创建运行的管道。 TriggerPipelineReference (必需)
typeProperties 翻转窗口触发器属性。 需要 TumblingWindowTriggerTypeProperties ()

TumblingWindowTriggerTypeProperties

名称 说明 值
delay 指定触发器在触发新运行之前等待超过到期时间的时长。 它不会更改窗口开始和结束时间。 默认值为 0。 类型：包含 resultType 字符串) 的字符串 (或表达式， pattern： ( (\d+) .) ？ (\d\d) ： (60， ([0-5][0-9]) ) ： (60， ([0-5][0-9]) ) 。
dependsOn 此触发器所依赖的触发器。 仅支持翻转窗口触发器。 DependencyReference[]
endTime 触发器的结束时间，在此期间，为已准备就绪的窗口触发事件。 目前仅支持 UTC 时间。 字符串
频率 时间窗口的频率。 “Hour”
“Minute”
“Month” (必需)
interval 时间窗口的间隔。 允许的最小间隔为 15 分钟。 int (必需)
maxConcurrency (为触发新运行的) 准备好执行的最大并行时间窗口数。 int (必需)

约束：
最小值 = 1
最大值 = 50
retryPolicy 将应用于失败的管道运行的重试策略。 RetryPolicy
startTime 触发器的时间段的开始时间，在此期间，为已准备就绪的窗口触发事件。 目前仅支持 UTC 时间。 字符串 (必需)

DependencyReference

名称 说明 Value
type 设置对象类型 SelfDependencyTumblingWindowTriggerReference
TumblingWindowTriggerDependencyReference (必需)

SelfDependencyTumblingWindowTriggerReference

名称 说明 Value
type 依赖项引用的类型。 “SelfDependencyTumblingWindowTriggerReference” (必需)
offset 评估依赖项时，时间跨度应用于翻转窗口的开始时间。 字符串 (必需)

约束：
最小长度 = 8
最大长度 = 15
Pattern = -((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))
大小 评估依赖项时窗口的大小。 如果未定义，将使用翻转窗口的频率。 字符串

约束：
最小长度 = 8
最大长度 = 15
Pattern = ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))

TumblingWindowTriggerDependencyReference

名称 说明 Value
type 依赖项引用的类型。 需要“TumblingWindowTriggerDependencyReference” ()
offset 评估依赖项时，时间跨度应用于翻转窗口的开始时间。 字符串

约束：
最小长度 = 8
最大长度 = 15
Pattern = -?((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))
referenceTrigger 引用的触发器。 TriggerReference (必需)
大小 评估依赖项时窗口的大小。 如果未定义，将使用翻转窗口的频率。 字符串

约束：
最小长度 = 8
最大长度 = 15
Pattern = ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))

TriggerReference

名称 说明 值
referenceName 引用触发器名称。 字符串 (必需)
类型 触发器引用类型。 “TriggerReference” (必需)

RetryPolicy

名称 说明 Value
count 最大普通重试尝试次数。 默认为 0。 类型：具有 resultType 整数) 的整数 (或 Expression，最小值：0。
intervalInSeconds 重试间隔（秒）。 默认值为 30。 int

约束：
最小值 = 30
最大值 = 86400

Terraform (AzAPI 提供程序) 资源定义

工厂/触发器资源类型可以通过针对以下操作进行部署：

  • 资源组

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DataFactory/factories/triggers 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/triggers@2018-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      annotations = [ object ]
      description = "string"
      type = "string"
      // For remaining properties, see Trigger objects
    }
  })
}

触发对象

设置 type 属性以指定对象的类型。

对于 BlobEventsTrigger，请使用：

  type = "BlobEventsTrigger"
  pipelines = [
    {
      parameters = {}
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "PipelineReference"
      }
    }
  ]
  typeProperties = {
    blobPathBeginsWith = "string"
    blobPathEndsWith = "string"
    events = [
      "string"
    ]
    ignoreEmptyBlobs = bool
    scope = "string"
  }

对于 BlobTrigger，请使用：

  type = "BlobTrigger"
  pipelines = [
    {
      parameters = {}
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "PipelineReference"
      }
    }
  ]
  typeProperties = {
    folderPath = "string"
    linkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    maxConcurrency = int
  }

对于 ChainingTrigger，请使用：

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

对于 CustomEventsTrigger，请使用：

  type = "CustomEventsTrigger"
  pipelines = [
    {
      parameters = {}
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "PipelineReference"
      }
    }
  ]
  typeProperties = {
    events = [ object ]
    scope = "string"
    subjectBeginsWith = "string"
    subjectEndsWith = "string"
  }

对于 RerunTumblingWindowTrigger，请使用：

  type = "RerunTumblingWindowTrigger"
  typeProperties = {
    requestedEndTime = "string"
    requestedStartTime = "string"
    rerunConcurrency = int
  }

对于 ScheduleTrigger，请使用：

  type = "ScheduleTrigger"
  pipelines = [
    {
      parameters = {}
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "PipelineReference"
      }
    }
  ]
  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"
    }
  }

对于 TumblingWindowTrigger，请使用：

  type = "TumblingWindowTrigger"
  pipeline = {
    parameters = {}
    pipelineReference = {
      name = "string"
      referenceName = "string"
      type = "PipelineReference"
    }
  }
  typeProperties = {
    dependsOn = [
      {
        type = "string"
        // For remaining properties, see DependencyReference objects
      }
    ]
    endTime = "string"
    frequency = "string"
    interval = int
    maxConcurrency = int
    retryPolicy = {
      intervalInSeconds = int
    }
    startTime = "string"
  }

DependencyReference 对象

设置 type 属性以指定对象的类型。

对于 SelfDependencyTumblingWindowTriggerReference，请使用：

  type = "SelfDependencyTumblingWindowTriggerReference"
  offset = "string"
  size = "string"

对于 TumblingWindowTriggerDependencyReference，请使用：

  type = "TumblingWindowTriggerDependencyReference"
  offset = "string"
  referenceTrigger = {
    referenceName = "string"
    type = "TriggerReference"
  }
  size = "string"

属性值

factories/triggers

名称 说明 Value
type 资源类型 “Microsoft.DataFactory/factories/triggers@2018-06-01”
name 资源名称 字符串 (必需)

字符限制：1-260

有效字符：
不得使用：
<>*#.%&:\\+?/ 或控制字符

以字母数字开头。
parent_id 此资源的父资源 ID。 类型为“工厂”的资源的 ID
properties 触发器的属性。 触发 (必需)

触发器

名称 说明 值
annotations 可用于描述触发器的标记列表。 any[]
description 触发器说明。 字符串
type 设置对象类型 BlobEventsTrigger
BlobTrigger
ChainingTrigger
CustomEventsTrigger
重新运行TumblingWindowTrigger
ScheduleTrigger
需要 TumblingWindowTrigger ()

BlobEventsTrigger

名称 说明 Value
type 触发器类型。 “BlobEventsTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties Blob 事件触发器属性。 BlobEventsTriggerTypeProperties (必需)

TriggerPipelineReference

名称 说明 值
parameters 管道参数。 ParameterValueSpecification
pipelineReference 管道引用。 PipelineReference

ParameterValueSpecification

名称 说明 值
{customized property}

PipelineReference

名称 说明 值
name 引用名称。 字符串
referenceName 引用管道名称。 字符串 (必需)
类型 管道引用类型。 “PipelineReference” (必需)

BlobEventsTriggerTypeProperties

名称 说明 值
blobPathBeginsWith Blob 路径必须使用为要触发的触发器提供的模式开头。 例如，“/records/blobs/december/”将仅针对 records 容器下的 december 文件夹中的 blob 使触发器触发。 必须至少提供其中一个：blobPathBeginsWith、blobPathEndsWith。 字符串
blobPathEndsWith Blob 路径必须使用为要触发的触发器提供的模式结尾。 例如，“december/boxes.csv”将仅针对 december 文件夹中名为 boxes 的 blob 使触发器触发。 必须至少提供其中一个：blobPathBeginsWith、blobPathEndsWith。 字符串
活动 导致此触发器触发的事件的类型。 包含任意项的字符串数组：
“Microsoft.Storage.BlobCreated”
需要“Microsoft.Storage.BlobDeleted” ()
ignoreEmptyBlobs 如果设置为 true，则将忽略包含零字节的 Blob。 bool
scope 存储帐户的 ARM 资源 ID。 字符串 (必需)

BlobTrigger

名称 说明 Value
type 触发器类型。 “BlobTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties Blob 触发器属性。 BlobTriggerTypeProperties (必需)

BlobTriggerTypeProperties

名称 说明 值
folderPath 将触发管道的容器/文件夹的路径。 字符串 (必需)
linkedService Azure 存储链接服务引用。 LinkedServiceReference (必需)
maxConcurrency 触发时要处理的并行文件的最大数量。 int (必需)

LinkedServiceReference

名称 说明 值
parameters LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 字符串 (必需)
类型 链接服务引用类型。 “LinkedServiceReference” (必需)

ChainingTrigger

名称 说明 Value
type 触发器类型。 需要“ChainingTrigger” ()
管道 当所有上游管道成功完成时，将为其创建运行。 TriggerPipelineReference (必需)
typeProperties 链接触发器属性。 ChainingTriggerTypeProperties (必需)

ChainingTriggerTypeProperties

名称 说明 值
dependsOn 上游管道。 PipelineReference[] (必需的)
runDimension 运行需要由上游管道发出的 Dimension 属性。 字符串 (必需)

CustomEventsTrigger

名称 说明 Value
type 触发器类型。 “CustomEventsTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties 自定义事件触发器属性。 CustomEventsTriggerTypeProperties (必需)

CustomEventsTriggerTypeProperties

名称 说明 值
活动 导致此触发器触发的事件类型的列表。 any[] (必需)
scope Azure 事件网格主题的 ARM 资源 ID。 字符串 (必需)
subjectBeginsWith 事件主题必须以为要触发的触发器提供的模式开头。 必须至少提供其中一个：subjectBeginsWith、subjectEndsWith。 字符串
subjectEndsWith 事件主题必须以为触发触发器提供的模式结束。 必须至少提供其中一个：subjectBeginsWith、subjectEndsWith。 字符串

重新运行TumblingWindowTrigger

名称 说明 Value
type 触发器类型。 “RerunTumblingWindowTrigger” (必需的)
typeProperties 重新运行触发器属性。 需要重新运行TumblingWindowTriggerTypeProperties ()

RerunTumblingWindowTriggerTypeProperties

名称 说明 值
parentTrigger 父触发器引用。
requestedEndTime 启动重述的时间段的结束时间。 目前仅支持 UTC 时间。 字符串 (必需)
requestedStartTime 启动重述的时间段的开始时间。 目前仅支持 UTC 时间。 字符串 (必需)
rerunConcurrency (已准备好执行) 触发重新运行的最大并行时间窗口数。 int (必需)

约束：
最小值 = 1
最大值 = 50

ScheduleTrigger

名称 说明 Value
type 触发器类型。 “ScheduleTrigger” (必需)
pipelines 需要启动的管道。 TriggerPipelineReference[]
typeProperties 计划触发器属性。 ScheduleTriggerTypeProperties (必需)

ScheduleTriggerTypeProperties

名称 说明 值
recurrence 定期计划配置。 ScheduleTriggerRecurrence (必需)

ScheduleTriggerRecurrence

名称 说明 值
endTime 结束时间。 字符串
频率 频率。 “Day”
“Hour”
“Minute”
“Month”
“NotSpecified”
“Week”
“Year”
interval 间隔。 int
schedule 定期计划。 RecurrenceSchedule
startTime 开始时间。 字符串
timezone 时区。 字符串
{customized property}

RecurrenceSchedule

名称 说明 值
小时 小时。 int[]
分钟数 分钟数。 int[]
monthDays 月天数。 int[]
monthlyOccurrences 每月出现次数。 RecurrenceScheduleOccurrence[]
工作日 一周中的几天。 包含任意项的字符串数组：
"Friday"
“星期一”
“星期六”
"Sunday"
"Thursday"
"Tuesday"
"Wednesday"
{customized property}

RecurrenceScheduleOccurrence

名称 说明 值
day 星期几。 "Friday"
“星期一”
“星期六”
"Sunday"
"Thursday"
"Tuesday"
"Wednesday"
occurrence 匹配项。 int
{customized property}

TumblingWindowTrigger

名称 说明 Value
type 触发器类型。 需要“TumblingWindowTrigger” ()
管道 为已准备就绪的触发器窗口触发事件时，将为其创建运行的管道。 TriggerPipelineReference (必需)
typeProperties 翻转窗口触发器属性。 需要 TumblingWindowTriggerTypeProperties ()

TumblingWindowTriggerTypeProperties

名称 说明 值
delay 指定触发器在触发新运行之前等待超过到期时间的时长。 它不会更改窗口开始和结束时间。 默认值为 0。 类型：字符串 (或带有 resultType 字符串) 的表达式， pattern： ( (\d+) .) ？ (\d\d) ： (60， ([0-5][0-9]) ) ： (60， ([0-5][0-9]) ) 。
dependsOn 此触发器所依赖的触发器。 仅支持翻转窗口触发器。 DependencyReference[]
endTime 触发器的时间段的结束时间，在此期间，为已就绪的窗口触发事件。 目前仅支持 UTC 时间。 字符串
频率 时间窗口的频率。 “Hour”
“Minute”
“Month” (必需)
interval 时间窗口的间隔。 允许的最小间隔为 15 分钟。 int (必需)
maxConcurrency 为触发新运行的) ， (准备执行的最大并行时间窗口数。 int (必需)

约束：
最小值 = 1
最大值 = 50
retryPolicy 将应用于失败管道运行的重试策略。 RetryPolicy
startTime 触发器的时间段的开始时间，在此期间，为已就绪的窗口触发事件。 目前仅支持 UTC 时间。 字符串 (必需)

DependencyReference

名称 说明 Value
type 设置对象类型 SelfDependencyTumblingWindowTriggerReference
TumblingWindowTriggerDependencyReference (所需的)

SelfDependencyTumblingWindowTriggerReference

名称 说明 Value
type 依赖项引用的类型。 “SelfDependencyTumblingWindowTriggerReference” (需要)
offset 评估依赖项时应用于翻转窗口开始时间的时间跨度。 字符串 (必需)

约束：
最小长度 = 8
最大长度 = 15
模式 = -((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))
大小 评估依赖项时窗口的大小。 如果未定义，将使用翻转窗口的频率。 字符串

约束：
最小长度 = 8
最大长度 = 15
模式 = ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))

TumblingWindowTriggerDependencyReference

名称 说明 Value
type 依赖项引用的类型。 “TumblingWindowTriggerDependencyReference” (需要)
offset 评估依赖项时应用于翻转窗口开始时间的时间跨度。 字符串

约束：
最小长度 = 8
最大长度 = 15
Pattern = -?((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))
referenceTrigger 引用的触发器。 TriggerReference (必需)
大小 评估依赖项时窗口的大小。 如果未定义，将使用翻转窗口的频率。 字符串

约束：
最小长度 = 8
最大长度 = 15
Pattern = ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))

TriggerReference

名称 说明 值
referenceName 引用触发器名称。 字符串 (必需)
类型 触发器引用类型。 “TriggerReference” (必需)

RetryPolicy

名称 说明 Value
count 最大普通重试尝试次数。 默认为 0。 类型：具有 resultType 整数) 的整数 (或 Expression，最小值：0。
intervalInSeconds 重试间隔（秒）。 默认值为 30。 int

约束：
最小值 = 30
最大值 = 86400