你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az datafactory trigger
注意
此参考是 Azure CLI(版本 2.15.0 或更高版本)的数据工厂扩展的一部分。 该扩展将在首次运行 az datafactory trigger 命令时自动安装。 详细了解扩展。
使用 datafactory 管理触发器。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az datafactory trigger create |
创建触发器。 |
扩展 | GA |
az datafactory trigger delete |
删除触发器。 |
扩展 | GA |
az datafactory trigger get-event-subscription-status |
获取触发器的事件订阅状态。 |
扩展 | GA |
az datafactory trigger list |
列出触发器。 |
扩展 | GA |
az datafactory trigger query-by-factory |
查询触发器。 |
扩展 | GA |
az datafactory trigger show |
获取触发器。 |
扩展 | GA |
az datafactory trigger start |
启动触发器。 |
扩展 | GA |
az datafactory trigger stop |
停止触发器。 |
扩展 | GA |
az datafactory trigger subscribe-to-event |
将事件触发器订阅到事件。 |
扩展 | GA |
az datafactory trigger unsubscribe-from-event |
取消订阅事件触发器的事件。 |
扩展 | GA |
az datafactory trigger update |
更新触发器。 |
扩展 | GA |
az datafactory trigger wait |
将 CLI 置于等待状态,直到满足数据工厂触发器的条件。 |
扩展 | GA |
az datafactory trigger create
创建触发器。
az datafactory trigger create --factory-name
--name
--properties
--resource-group
[--if-match]
示例
Triggers_Create
az datafactory trigger create --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --properties "{\"type\":\"ScheduleTrigger\",\"pipelines\":[{\"parameters\":{\"OutputBlobNameList\":[\"exampleoutput.csv\"]},\"pipelineReference\":{\"type\":\"PipelineReference\",\"referenceName\":\"examplePipeline\"}}],\"typeProperties\":{\"recurrence\":{\"endTime\":\"2018-06-16T00:55:13.8441801Z\",\"frequency\":\"Minute\",\"interval\":4,\"startTime\":\"2018-06-16T00:39:13.8441801Z\",\"timeZone\":\"UTC\"}}}" --name "exampleTrigger"
必需参数
工厂名称。
触发器名称。
触发器的属性。 预期值:json-string/json-file/@json-file。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
触发器实体的 ETag。 应仅指定用于更新,应将其与现有实体匹配,也可以为 * 进行无条件更新。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger delete
删除触发器。
az datafactory trigger delete [--factory-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
示例
Triggers_Delete
az datafactory trigger delete --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger get-event-subscription-status
获取触发器的事件订阅状态。
az datafactory trigger get-event-subscription-status [--factory-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
示例
Triggers_GetEventSubscriptionStatus
az datafactory trigger get-event-subscription-status --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger list
列出触发器。
az datafactory trigger list --factory-name
--resource-group
示例
Triggers_ListByFactory
az datafactory trigger list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
必需参数
工厂名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger query-by-factory
查询触发器。
az datafactory trigger query-by-factory [--continuation-token]
[--factory-name]
[--ids]
[--parent-trigger-name]
[--resource-group]
[--subscription]
示例
Triggers_QueryByFactory
az datafactory trigger query-by-factory --factory-name "exampleFactoryName" --parent-trigger-name "exampleTrigger" --resource-group "exampleResourceGroup"
可选参数
用于获取下一页结果的延续标记。 第一页的 Null。
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
用于获取子级重新运行触发器的父 TumblingWindowTrigger 的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger show
获取触发器。
az datafactory trigger show [--factory-name]
[--ids]
[--if-none-match]
[--name]
[--resource-group]
[--subscription]
示例
Triggers_Get
az datafactory trigger show --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。
触发器名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger start
启动触发器。
az datafactory trigger start [--factory-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
示例
Triggers_Start
az datafactory trigger start --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger stop
停止触发器。
az datafactory trigger stop [--factory-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
示例
Triggers_Stop
az datafactory trigger stop --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger subscribe-to-event
将事件触发器订阅到事件。
az datafactory trigger subscribe-to-event [--factory-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
示例
Triggers_SubscribeToEvents
az datafactory trigger subscribe-to-event --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger unsubscribe-from-event
取消订阅事件触发器的事件。
az datafactory trigger unsubscribe-from-event [--factory-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
示例
Triggers_UnsubscribeFromEvents
az datafactory trigger unsubscribe-from-event --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger update
更新触发器。
az datafactory trigger update [--add]
[--annotations]
[--description]
[--factory-name]
[--force-string]
[--ids]
[--if-match]
[--if-none-match]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
可用于描述触发器的标记列表。 预期值:json-string/json-file/@json-file。
触发器说明。
工厂名称。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器实体的 ETag。 应仅指定用于更新,应将其与现有实体匹配,也可以为 * 进行无条件更新。
触发器实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。 默认值为 None。
触发器名称。
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory trigger wait
将 CLI 置于等待状态,直到满足数据工厂触发器的条件。
az datafactory trigger wait [--created]
[--custom]
[--deleted]
[--exists]
[--factory-name]
[--ids]
[--if-none-match]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
示例
暂停执行下一行 CLI 脚本,直到成功创建数据工厂触发器。
az datafactory trigger wait --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger" --created
可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到删除为止。
等待资源存在。
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
触发器实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。
轮询间隔(以秒为单位)。
触发器名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。