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

Microsoft.DataFactory 工厂/触发器 2018-06-01

Bicep 资源定义

工厂/触发器资源类型可以使用目标操作进行部署:

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

资源格式

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

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
  }
}

触发器对象

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

对于 BlobEventsTrigger,请使用:

{
  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'
  }
}

对于 BlobTrigger,请使用:

{
  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
  }
}

对于 ChainingTrigger,请使用:

{
  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'
  }
}

对于 customEventsTrigger,请使用:

{
  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'
  }
}

对于 ScheduleTrigger,请使用:

{
  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'
    }
  }
}

对于 RerunTumblingWindowTrigger,请使用:

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

对于 TumblingWindowTrigger,请使用:

{
  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 对象

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

对于 SelfDependencyTumblingWindowTriggerReference,请使用:

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

对于 TumblingWindowTriggerDependencyReference,请使用:

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

属性值

BlobEventsTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “BlobEventsTrigger”(必需)
typeProperties Blob 事件触发器属性。 BlobEventsTriggerTypeProperties(必需)

BlobEventsTriggerTypeProperties

名字 描述 价值
blobPathBeginsWith Blob 路径必须以提供的模式开头,以便触发触发器。 例如,“/records/blobs/december/”将仅触发记录容器下 12 月文件夹中 blob 的触发器。 必须至少提供其中一个:blobPathBeginsWith、blobPathEndsWith。 字符串
blobPathEndsWith Blob 路径必须以提供的模式结束,以便触发触发器。 例如,“december/boxes.csv”只会为 12 月文件夹中名为框的 blob 触发触发器。 必须至少提供其中一个:blobPathBeginsWith、blobPathEndsWith。 字符串
事件 导致触发此触发器的事件的类型。 包含任一项的字符串数组:
“Microsoft.Storage.BlobCreated”
“Microsoft.Storage.BlobDeleted”(必需)
ignoreEmptyBlobs 如果设置为 true,将忽略包含零字节的 Blob。 bool
范围 存储帐户的 ARM 资源 ID。 string (必需)

BlobTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “BlobTrigger”(必需)
typeProperties Blob 触发器属性。 BlobTriggerTypeProperties(必需)

BlobTriggerTypeProperties

名字 描述 价值
folderPath 将触发管道的容器/文件夹的路径。 string (必需)
linkedService Azure 存储链接服务参考。 LinkedServiceReference(必需)
maxConcurrency 触发时要处理的最大并行文件数。 int (必需)

ChainingTrigger

名字 描述 价值
管道 当所有上游管道成功完成时,将为其创建运行的管道。 TriggerPipelineReference (必需)
类型 触发器类型。 “ChainingTrigger”(必需)
typeProperties 链接触发器属性。 ChainingTriggerTypeProperties (必需)

ChainingTriggerTypeProperties

名字 描述 价值
dependsOn 上游管道。 PipelineReference[] (必需)
runDimension 运行上游管道需要发出的 Dimension 属性。 string (必需)

CustomEventsTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “CustomEventsTrigger”(必需)
typeProperties 自定义事件触发器属性。 CustomEventsTriggerTypeProperties (必需)

CustomEventsTriggerTypeProperties

名字 描述 价值
事件 导致触发此触发器的事件类型的列表。 any[] (必需)
范围 Azure 事件网格主题的 ARM 资源 ID。 string (必需)
subjectBeginsWith 事件主题必须以提供的模式开头,以便触发触发器。 必须至少提供其中一个:subjectBeginsWith、subjectEndsWith。 字符串
subjectEndsWith 事件主题必须以提供的模式结束,以便触发触发器。 必须至少提供其中一个:subjectBeginsWith、subjectEndsWith。 字符串

DependencyReference

名字 描述 价值
类型 对于 type SelfDependencyTumblingWindowTriggerReference,设置为“SelfDependencyTumblingWindowTriggerReference”。 对于 TumblingWindowTriggerDependencyReference,请设置为“TumblingWindowTriggerDependencyReference”。 “SelfDependencyTumblingWindowTriggerReference”
“TumblingWindowTriggerDependencyReference”(必需)

LinkedServiceReference

名字 描述 价值
参数 LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 string (必需)
类型 链接服务引用类型。 “LinkedServiceReference”(必需)

Microsoft.DataFactory/factories/triggers

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 260
模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:工厂
性能 触发器的属性。 触发器(必需)

ParameterValueSpecification

名字 描述 价值

ParameterValueSpecification

名字 描述 价值

PipelineReference

名字 描述 价值
名字 引用名称。 字符串
referenceName 引用管道名称。 string (必需)
类型 管道引用类型。 “PipelineReference”(必需)

RecurrenceSchedule

名字 描述 价值
小时 小时数。 int[]
纪要 分钟数。 int[]
monthDays 月天。 int[]
monthlyOccurrences 每月发生次数。 RecurrenceScheduleOccurrence[]
平日 星期几。 包含任一项的字符串数组:
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”

RecurrenceScheduleOccurrence

名字 描述 价值
一周中的一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
发生 出现次数。 int

RerunTumblingWindowTrigger

名字 描述 价值
类型 触发器类型。 “RerunTumblingWindowTrigger”(必需)
typeProperties 重新运行触发器属性。 RerunTumblingWindowTriggerTypeProperties (必需)

RerunTumblingWindowTriggerTypeProperties

名字 描述 价值
parentTrigger 父触发器引用。 任何(必需)
requestedEndTime 启动重述的时间段的结束时间。 目前仅支持 UTC 时间。 string (必需)
requestedStartTime 启动重述的时间段的开始时间。 目前仅支持 UTC 时间。 string (必需)
rerunConcurrency 触发重新运行的最大并行时间窗口数(可供执行)。 int

约束:
最小值 = 1
最大值 = 50 (必需)

RetryPolicy

名字 描述 价值
计数 最大普通重试尝试次数。 默认值为 0。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 任何
intervalInSeconds 重试间隔(以秒为单位)。 默认值为 30。 int

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

ScheduleTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “ScheduleTrigger”(必需)
typeProperties 计划触发器属性。 ScheduleTriggerTypeProperties (必需)

ScheduleTriggerRecurrence

名字 描述 价值
endTime 结束时间。 字符串
频率 频率。 “Day”
“Hour”
“Minute”
“Month”
“NotSpecified”
“Week”
“Year”
间隔 间隔。 int
附表 重复计划。 RecurrenceSchedule
startTime 开始时间。 字符串
timeZone 时区。 字符串

ScheduleTriggerTypeProperties

名字 描述 价值
复发 定期计划配置。 ScheduleTriggerRecurrence(必需)

SelfDependencyTumblingWindowTriggerReference

名字 描述 价值
抵消 在评估依赖项时,应用于翻转窗口的开始时间跨度。 字符串

约束:
最小长度 = 8
最大长度 = 15
模式 = -((\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]))
类型 依赖项引用的类型。 “SelfDependencyTumblingWindowTriggerReference”(必需)

触发

名字 描述 价值
附注 可用于描述触发器的标记列表。 any[]
描述 触发器说明。 字符串
类型 对于 BlobEventsTrigger,请设置为“BlobEventsTrigger”。 对于 BlobTrigger,请设置为“BlobTrigger”。 对于 ChainingTrigger类型,设置为“ChainingTrigger”。 对于 type CustomEventsTrigger,设置为“CustomEventsTrigger”。 对于 ScheduleTrigger类型,设置为“ScheduleTrigger”。 对于类型 RerunTumblingWindowTrigger,设置为“RerunTumblingWindowTrigger”。 对于 TumblingWindowTrigger类型,设置为“TumblingWindowTrigger”。 “BlobEventsTrigger”
“BlobTrigger”
“ChainingTrigger”
“CustomEventsTrigger”
“RerunTumblingWindowTrigger”
“ScheduleTrigger”
“TumblingWindowTrigger”(必需)

TriggerPipelineReference

名字 描述 价值
参数 管道参数。 ParameterValueSpecification
pipelineReference 管道引用。 PipelineReference

TriggerReference

名字 描述 价值
referenceName 引用触发器名称。 string (必需)
类型 触发器引用类型。 “TriggerReference”(必需)

TumblingWindowTrigger

名字 描述 价值
管道 为已准备好的触发器窗口触发事件时,将为其创建运行的管道。 TriggerPipelineReference (必需)
类型 触发器类型。 “TumblingWindowTrigger”(必需)
typeProperties 翻转窗口触发器属性。 TumblingWindowTriggerTypeProperties (必需)

TumblingWindowTriggerDependencyReference

名字 描述 价值
抵消 在评估依赖项时,应用于翻转窗口的开始时间跨度。 字符串

约束:
最小长度 = 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]))
类型 依赖项引用的类型。 “TumblingWindowTriggerDependencyReference”(必需)

TumblingWindowTriggerTypeProperties

名字 描述 价值
延迟 指定触发器在触发新运行之前等待超过到期时间的时间。 它不会更改窗口的开始时间和结束时间。 默认值为 0。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 ([0-5][0-9])):(60 ([0-5][0-9])). 任何
dependsOn 此触发器所依赖的触发器。 仅支持翻转窗口触发器。 DependencyReference[]
endTime 触发器的时间段的结束时间,在此期间,为已准备好的窗口触发事件。 目前仅支持 UTC 时间。 字符串
频率 时间窗口的频率。 “Hour”
“Minute”
“Month”(必需)
间隔 时间窗口的间隔。 允许的最小间隔为 15 分钟。 int (必需)
maxConcurrency 触发新运行的最大并行时间窗口数(可供执行)。 int

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

ARM 模板资源定义

工厂/触发器资源类型可以使用目标操作进行部署:

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

资源格式

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

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

触发器对象

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

对于 BlobEventsTrigger,请使用:

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

对于 BlobTrigger,请使用:

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

对于 ChainingTrigger,请使用:

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

对于 customEventsTrigger,请使用:

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

对于 ScheduleTrigger,请使用:

{
  "pipelines": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "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"
    }
  }
}

对于 RerunTumblingWindowTrigger,请使用:

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

对于 TumblingWindowTrigger,请使用:

{
  "pipeline": {
    "parameters": {
      "{customized property}": {}
    },
    "pipelineReference": {
      "name": "string",
      "referenceName": "string",
      "type": "string"
    }
  },
  "type": "TumblingWindowTrigger",
  "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 对象

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

对于 SelfDependencyTumblingWindowTriggerReference,请使用:

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

对于 TumblingWindowTriggerDependencyReference,请使用:

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

属性值

BlobEventsTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “BlobEventsTrigger”(必需)
typeProperties Blob 事件触发器属性。 BlobEventsTriggerTypeProperties(必需)

BlobEventsTriggerTypeProperties

名字 描述 价值
blobPathBeginsWith Blob 路径必须以提供的模式开头,以便触发触发器。 例如,“/records/blobs/december/”将仅触发记录容器下 12 月文件夹中 blob 的触发器。 必须至少提供其中一个:blobPathBeginsWith、blobPathEndsWith。 字符串
blobPathEndsWith Blob 路径必须以提供的模式结束,以便触发触发器。 例如,“december/boxes.csv”只会为 12 月文件夹中名为框的 blob 触发触发器。 必须至少提供其中一个:blobPathBeginsWith、blobPathEndsWith。 字符串
事件 导致触发此触发器的事件的类型。 包含任一项的字符串数组:
“Microsoft.Storage.BlobCreated”
“Microsoft.Storage.BlobDeleted”(必需)
ignoreEmptyBlobs 如果设置为 true,将忽略包含零字节的 Blob。 bool
范围 存储帐户的 ARM 资源 ID。 string (必需)

BlobTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “BlobTrigger”(必需)
typeProperties Blob 触发器属性。 BlobTriggerTypeProperties(必需)

BlobTriggerTypeProperties

名字 描述 价值
folderPath 将触发管道的容器/文件夹的路径。 string (必需)
linkedService Azure 存储链接服务参考。 LinkedServiceReference(必需)
maxConcurrency 触发时要处理的最大并行文件数。 int (必需)

ChainingTrigger

名字 描述 价值
管道 当所有上游管道成功完成时,将为其创建运行的管道。 TriggerPipelineReference (必需)
类型 触发器类型。 “ChainingTrigger”(必需)
typeProperties 链接触发器属性。 ChainingTriggerTypeProperties (必需)

ChainingTriggerTypeProperties

名字 描述 价值
dependsOn 上游管道。 PipelineReference[] (必需)
runDimension 运行上游管道需要发出的 Dimension 属性。 string (必需)

CustomEventsTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “CustomEventsTrigger”(必需)
typeProperties 自定义事件触发器属性。 CustomEventsTriggerTypeProperties (必需)

CustomEventsTriggerTypeProperties

名字 描述 价值
事件 导致触发此触发器的事件类型的列表。 any[] (必需)
范围 Azure 事件网格主题的 ARM 资源 ID。 string (必需)
subjectBeginsWith 事件主题必须以提供的模式开头,以便触发触发器。 必须至少提供其中一个:subjectBeginsWith、subjectEndsWith。 字符串
subjectEndsWith 事件主题必须以提供的模式结束,以便触发触发器。 必须至少提供其中一个:subjectBeginsWith、subjectEndsWith。 字符串

DependencyReference

名字 描述 价值
类型 对于 type SelfDependencyTumblingWindowTriggerReference,设置为“SelfDependencyTumblingWindowTriggerReference”。 对于 TumblingWindowTriggerDependencyReference,请设置为“TumblingWindowTriggerDependencyReference”。 “SelfDependencyTumblingWindowTriggerReference”
“TumblingWindowTriggerDependencyReference”(必需)

LinkedServiceReference

名字 描述 价值
参数 LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 string (必需)
类型 链接服务引用类型。 “LinkedServiceReference”(必需)

Microsoft.DataFactory/factories/triggers

名字 描述 价值
apiVersion API 版本 '2018-06-01'
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 260
模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需)
性能 触发器的属性。 触发器(必需)
类型 资源类型 “Microsoft.DataFactory/factories/triggers”

ParameterValueSpecification

名字 描述 价值

ParameterValueSpecification

名字 描述 价值

PipelineReference

名字 描述 价值
名字 引用名称。 字符串
referenceName 引用管道名称。 string (必需)
类型 管道引用类型。 “PipelineReference”(必需)

RecurrenceSchedule

名字 描述 价值
小时 小时数。 int[]
纪要 分钟数。 int[]
monthDays 月天。 int[]
monthlyOccurrences 每月发生次数。 RecurrenceScheduleOccurrence[]
平日 星期几。 包含任一项的字符串数组:
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”

RecurrenceScheduleOccurrence

名字 描述 价值
一周中的一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
发生 出现次数。 int

RerunTumblingWindowTrigger

名字 描述 价值
类型 触发器类型。 “RerunTumblingWindowTrigger”(必需)
typeProperties 重新运行触发器属性。 RerunTumblingWindowTriggerTypeProperties (必需)

RerunTumblingWindowTriggerTypeProperties

名字 描述 价值
parentTrigger 父触发器引用。 任何(必需)
requestedEndTime 启动重述的时间段的结束时间。 目前仅支持 UTC 时间。 string (必需)
requestedStartTime 启动重述的时间段的开始时间。 目前仅支持 UTC 时间。 string (必需)
rerunConcurrency 触发重新运行的最大并行时间窗口数(可供执行)。 int

约束:
最小值 = 1
最大值 = 50 (必需)

RetryPolicy

名字 描述 价值
计数 最大普通重试尝试次数。 默认值为 0。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 任何
intervalInSeconds 重试间隔(以秒为单位)。 默认值为 30。 int

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

ScheduleTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “ScheduleTrigger”(必需)
typeProperties 计划触发器属性。 ScheduleTriggerTypeProperties (必需)

ScheduleTriggerRecurrence

名字 描述 价值
endTime 结束时间。 字符串
频率 频率。 “Day”
“Hour”
“Minute”
“Month”
“NotSpecified”
“Week”
“Year”
间隔 间隔。 int
附表 重复计划。 RecurrenceSchedule
startTime 开始时间。 字符串
timeZone 时区。 字符串

ScheduleTriggerTypeProperties

名字 描述 价值
复发 定期计划配置。 ScheduleTriggerRecurrence(必需)

SelfDependencyTumblingWindowTriggerReference

名字 描述 价值
抵消 在评估依赖项时,应用于翻转窗口的开始时间跨度。 字符串

约束:
最小长度 = 8
最大长度 = 15
模式 = -((\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]))
类型 依赖项引用的类型。 “SelfDependencyTumblingWindowTriggerReference”(必需)

触发

名字 描述 价值
附注 可用于描述触发器的标记列表。 any[]
描述 触发器说明。 字符串
类型 对于 BlobEventsTrigger,请设置为“BlobEventsTrigger”。 对于 BlobTrigger,请设置为“BlobTrigger”。 对于 ChainingTrigger类型,设置为“ChainingTrigger”。 对于 type CustomEventsTrigger,设置为“CustomEventsTrigger”。 对于 ScheduleTrigger类型,设置为“ScheduleTrigger”。 对于类型 RerunTumblingWindowTrigger,设置为“RerunTumblingWindowTrigger”。 对于 TumblingWindowTrigger类型,设置为“TumblingWindowTrigger”。 “BlobEventsTrigger”
“BlobTrigger”
“ChainingTrigger”
“CustomEventsTrigger”
“RerunTumblingWindowTrigger”
“ScheduleTrigger”
“TumblingWindowTrigger”(必需)

TriggerPipelineReference

名字 描述 价值
参数 管道参数。 ParameterValueSpecification
pipelineReference 管道引用。 PipelineReference

TriggerReference

名字 描述 价值
referenceName 引用触发器名称。 string (必需)
类型 触发器引用类型。 “TriggerReference”(必需)

TumblingWindowTrigger

名字 描述 价值
管道 为已准备好的触发器窗口触发事件时,将为其创建运行的管道。 TriggerPipelineReference (必需)
类型 触发器类型。 “TumblingWindowTrigger”(必需)
typeProperties 翻转窗口触发器属性。 TumblingWindowTriggerTypeProperties (必需)

TumblingWindowTriggerDependencyReference

名字 描述 价值
抵消 在评估依赖项时,应用于翻转窗口的开始时间跨度。 字符串

约束:
最小长度 = 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]))
类型 依赖项引用的类型。 “TumblingWindowTriggerDependencyReference”(必需)

TumblingWindowTriggerTypeProperties

名字 描述 价值
延迟 指定触发器在触发新运行之前等待超过到期时间的时间。 它不会更改窗口的开始时间和结束时间。 默认值为 0。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 ([0-5][0-9])):(60 ([0-5][0-9])). 任何
dependsOn 此触发器所依赖的触发器。 仅支持翻转窗口触发器。 DependencyReference[]
endTime 触发器的时间段的结束时间,在此期间,为已准备好的窗口触发事件。 目前仅支持 UTC 时间。 字符串
频率 时间窗口的频率。 “Hour”
“Minute”
“Month”(必需)
间隔 时间窗口的间隔。 允许的最小间隔为 15 分钟。 int (必需)
maxConcurrency 触发新运行的最大并行时间窗口数(可供执行)。 int

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

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

工厂/触发器资源类型可以使用目标操作进行部署:

  • 资源组

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

资源格式

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

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

触发器对象

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

对于 BlobEventsTrigger,请使用:

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

对于 BlobTrigger,请使用:

{
  pipelines = [
    {
      parameters = {
        {customized property} = ?
      }
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "string"
      }
    }
  ]
  type = "BlobTrigger"
  typeProperties = {
    folderPath = "string"
    linkedService = {
      parameters = {
        {customized property} = ?
      }
      referenceName = "string"
      type = "string"
    }
    maxConcurrency = int
  }
}

对于 ChainingTrigger,请使用:

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

对于 customEventsTrigger,请使用:

{
  pipelines = [
    {
      parameters = {
        {customized property} = ?
      }
      pipelineReference = {
        name = "string"
        referenceName = "string"
        type = "string"
      }
    }
  ]
  type = "CustomEventsTrigger"
  typeProperties = {
    events = [
      ?
    ]
    scope = "string"
    subjectBeginsWith = "string"
    subjectEndsWith = "string"
  }
}

对于 ScheduleTrigger,请使用:

{
  pipelines = [
    {
      parameters = {
        {customized property} = ?
      }
      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"
    }
  }
}

对于 RerunTumblingWindowTrigger,请使用:

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

对于 TumblingWindowTrigger,请使用:

{
  pipeline = {
    parameters = {
      {customized property} = ?
    }
    pipelineReference = {
      name = "string"
      referenceName = "string"
      type = "string"
    }
  }
  type = "TumblingWindowTrigger"
  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 对象

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

对于 SelfDependencyTumblingWindowTriggerReference,请使用:

{
  offset = "string"
  size = "string"
  type = "SelfDependencyTumblingWindowTriggerReference"
}

对于 TumblingWindowTriggerDependencyReference,请使用:

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

属性值

BlobEventsTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “BlobEventsTrigger”(必需)
typeProperties Blob 事件触发器属性。 BlobEventsTriggerTypeProperties(必需)

BlobEventsTriggerTypeProperties

名字 描述 价值
blobPathBeginsWith Blob 路径必须以提供的模式开头,以便触发触发器。 例如,“/records/blobs/december/”将仅触发记录容器下 12 月文件夹中 blob 的触发器。 必须至少提供其中一个:blobPathBeginsWith、blobPathEndsWith。 字符串
blobPathEndsWith Blob 路径必须以提供的模式结束,以便触发触发器。 例如,“december/boxes.csv”只会为 12 月文件夹中名为框的 blob 触发触发器。 必须至少提供其中一个:blobPathBeginsWith、blobPathEndsWith。 字符串
事件 导致触发此触发器的事件的类型。 包含任一项的字符串数组:
“Microsoft.Storage.BlobCreated”
“Microsoft.Storage.BlobDeleted”(必需)
ignoreEmptyBlobs 如果设置为 true,将忽略包含零字节的 Blob。 bool
范围 存储帐户的 ARM 资源 ID。 string (必需)

BlobTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “BlobTrigger”(必需)
typeProperties Blob 触发器属性。 BlobTriggerTypeProperties(必需)

BlobTriggerTypeProperties

名字 描述 价值
folderPath 将触发管道的容器/文件夹的路径。 string (必需)
linkedService Azure 存储链接服务参考。 LinkedServiceReference(必需)
maxConcurrency 触发时要处理的最大并行文件数。 int (必需)

ChainingTrigger

名字 描述 价值
管道 当所有上游管道成功完成时,将为其创建运行的管道。 TriggerPipelineReference (必需)
类型 触发器类型。 “ChainingTrigger”(必需)
typeProperties 链接触发器属性。 ChainingTriggerTypeProperties (必需)

ChainingTriggerTypeProperties

名字 描述 价值
dependsOn 上游管道。 PipelineReference[] (必需)
runDimension 运行上游管道需要发出的 Dimension 属性。 string (必需)

CustomEventsTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “CustomEventsTrigger”(必需)
typeProperties 自定义事件触发器属性。 CustomEventsTriggerTypeProperties (必需)

CustomEventsTriggerTypeProperties

名字 描述 价值
事件 导致触发此触发器的事件类型的列表。 any[] (必需)
范围 Azure 事件网格主题的 ARM 资源 ID。 string (必需)
subjectBeginsWith 事件主题必须以提供的模式开头,以便触发触发器。 必须至少提供其中一个:subjectBeginsWith、subjectEndsWith。 字符串
subjectEndsWith 事件主题必须以提供的模式结束,以便触发触发器。 必须至少提供其中一个:subjectBeginsWith、subjectEndsWith。 字符串

DependencyReference

名字 描述 价值
类型 对于 type SelfDependencyTumblingWindowTriggerReference,设置为“SelfDependencyTumblingWindowTriggerReference”。 对于 TumblingWindowTriggerDependencyReference,请设置为“TumblingWindowTriggerDependencyReference”。 “SelfDependencyTumblingWindowTriggerReference”
“TumblingWindowTriggerDependencyReference”(必需)

LinkedServiceReference

名字 描述 价值
参数 LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 string (必需)
类型 链接服务引用类型。 “LinkedServiceReference”(必需)

Microsoft.DataFactory/factories/triggers

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 260
模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:工厂
性能 触发器的属性。 触发器(必需)
类型 资源类型 “Microsoft.DataFactory/factories/triggers@2018-06-01”

ParameterValueSpecification

名字 描述 价值

ParameterValueSpecification

名字 描述 价值

PipelineReference

名字 描述 价值
名字 引用名称。 字符串
referenceName 引用管道名称。 string (必需)
类型 管道引用类型。 “PipelineReference”(必需)

RecurrenceSchedule

名字 描述 价值
小时 小时数。 int[]
纪要 分钟数。 int[]
monthDays 月天。 int[]
monthlyOccurrences 每月发生次数。 RecurrenceScheduleOccurrence[]
平日 星期几。 包含任一项的字符串数组:
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”

RecurrenceScheduleOccurrence

名字 描述 价值
一周中的一天。 “Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
发生 出现次数。 int

RerunTumblingWindowTrigger

名字 描述 价值
类型 触发器类型。 “RerunTumblingWindowTrigger”(必需)
typeProperties 重新运行触发器属性。 RerunTumblingWindowTriggerTypeProperties (必需)

RerunTumblingWindowTriggerTypeProperties

名字 描述 价值
parentTrigger 父触发器引用。 任何(必需)
requestedEndTime 启动重述的时间段的结束时间。 目前仅支持 UTC 时间。 string (必需)
requestedStartTime 启动重述的时间段的开始时间。 目前仅支持 UTC 时间。 string (必需)
rerunConcurrency 触发重新运行的最大并行时间窗口数(可供执行)。 int

约束:
最小值 = 1
最大值 = 50 (必需)

RetryPolicy

名字 描述 价值
计数 最大普通重试尝试次数。 默认值为 0。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 任何
intervalInSeconds 重试间隔(以秒为单位)。 默认值为 30。 int

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

ScheduleTrigger

名字 描述 价值
管道 需要启动的管道。 TriggerPipelineReference[]
类型 触发器类型。 “ScheduleTrigger”(必需)
typeProperties 计划触发器属性。 ScheduleTriggerTypeProperties (必需)

ScheduleTriggerRecurrence

名字 描述 价值
endTime 结束时间。 字符串
频率 频率。 “Day”
“Hour”
“Minute”
“Month”
“NotSpecified”
“Week”
“Year”
间隔 间隔。 int
附表 重复计划。 RecurrenceSchedule
startTime 开始时间。 字符串
timeZone 时区。 字符串

ScheduleTriggerTypeProperties

名字 描述 价值
复发 定期计划配置。 ScheduleTriggerRecurrence(必需)

SelfDependencyTumblingWindowTriggerReference

名字 描述 价值
抵消 在评估依赖项时,应用于翻转窗口的开始时间跨度。 字符串

约束:
最小长度 = 8
最大长度 = 15
模式 = -((\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]))
类型 依赖项引用的类型。 “SelfDependencyTumblingWindowTriggerReference”(必需)

触发

名字 描述 价值
附注 可用于描述触发器的标记列表。 any[]
描述 触发器说明。 字符串
类型 对于 BlobEventsTrigger,请设置为“BlobEventsTrigger”。 对于 BlobTrigger,请设置为“BlobTrigger”。 对于 ChainingTrigger类型,设置为“ChainingTrigger”。 对于 type CustomEventsTrigger,设置为“CustomEventsTrigger”。 对于 ScheduleTrigger类型,设置为“ScheduleTrigger”。 对于类型 RerunTumblingWindowTrigger,设置为“RerunTumblingWindowTrigger”。 对于 TumblingWindowTrigger类型,设置为“TumblingWindowTrigger”。 “BlobEventsTrigger”
“BlobTrigger”
“ChainingTrigger”
“CustomEventsTrigger”
“RerunTumblingWindowTrigger”
“ScheduleTrigger”
“TumblingWindowTrigger”(必需)

TriggerPipelineReference

名字 描述 价值
参数 管道参数。 ParameterValueSpecification
pipelineReference 管道引用。 PipelineReference

TriggerReference

名字 描述 价值
referenceName 引用触发器名称。 string (必需)
类型 触发器引用类型。 “TriggerReference”(必需)

TumblingWindowTrigger

名字 描述 价值
管道 为已准备好的触发器窗口触发事件时,将为其创建运行的管道。 TriggerPipelineReference (必需)
类型 触发器类型。 “TumblingWindowTrigger”(必需)
typeProperties 翻转窗口触发器属性。 TumblingWindowTriggerTypeProperties (必需)

TumblingWindowTriggerDependencyReference

名字 描述 价值
抵消 在评估依赖项时,应用于翻转窗口的开始时间跨度。 字符串

约束:
最小长度 = 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]))
类型 依赖项引用的类型。 “TumblingWindowTriggerDependencyReference”(必需)

TumblingWindowTriggerTypeProperties

名字 描述 价值
延迟 指定触发器在触发新运行之前等待超过到期时间的时间。 它不会更改窗口的开始时间和结束时间。 默认值为 0。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 ([0-5][0-9])):(60 ([0-5][0-9])). 任何
dependsOn 此触发器所依赖的触发器。 仅支持翻转窗口触发器。 DependencyReference[]
endTime 触发器的时间段的结束时间,在此期间,为已准备好的窗口触发事件。 目前仅支持 UTC 时间。 字符串
频率 时间窗口的频率。 “Hour”
“Minute”
“Month”(必需)
间隔 时间窗口的间隔。 允许的最小间隔为 15 分钟。 int (必需)
maxConcurrency 触发新运行的最大并行时间窗口数(可供执行)。 int

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