az datafactory trigger

注意

此參考是 Azure CLI 的 datafactory 延伸模組的一部分（2.15.0 版或更高版本）。 擴充功能會在您第一次執行 az datafactory trigger 命令時自動安裝。 深入了解擴充功能。

使用 datafactory 管理觸發程式。

命令

名稱	Description	類型	狀態
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 置於等候狀態，直到符合 datafactory 觸發程式的條件為止。	副檔名	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"

必要參數

--factory-name

Factory 名稱。

--name --trigger-name -n

觸發程式名稱。

--properties

觸發程序的屬性。 預期值：json-string/json-file/@json-file。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

選擇性參數

--if-match

觸發程式實體的 ETag。 應該只針對更新指定，而更新應該符合現有的實體，也可以為 * 進行無條件更新。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name --trigger-name -n

觸發程式名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name --trigger-name -n

觸發程式名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

必要參數

--factory-name

Factory 名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--continuation-token

取得下一頁結果的接續令牌。 第一頁的 Null。

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--parent-trigger-name

要取得子系重新執行觸發程式之父 TumblingWindowTrigger 的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--if-none-match

觸發程式實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。

--name --trigger-name -n

觸發程式名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name --trigger-name -n

觸發程式名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name --trigger-name -n

觸發程式名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name --trigger-name -n

觸發程式名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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"

選擇性參數

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name --trigger-name -n

觸發程式名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。

預設值: []

--annotations

可用於描述觸發程式的標記清單。 預期值：json-string/json-file/@json-file。

--description

觸發程式描述。

--factory-name

Factory 名稱。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

預設值: False

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--if-match

觸發程式實體的 ETag。 應該只針對更新指定，而更新應該符合現有的實體，也可以為 * 進行無條件更新。

--if-none-match

觸發程式實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。 預設值為 None。

--name --trigger-name -n

觸發程式名稱。

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

預設值: []

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az datafactory trigger wait

將 CLI 置於等候狀態，直到符合 datafactory 觸發程式的條件為止。

az datafactory trigger wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--factory-name]
                            [--ids]
                            [--if-none-match]
                            [--interval]
                            [--name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

範例

暫停執行下一行 CLI 腳本，直到成功建立 datafactory 觸發程序為止。

az datafactory trigger wait --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger" --created

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--factory-name

Factory 名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--if-none-match

觸發程式實體的 ETag。 應該只指定 get。 如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。

--interval

輪詢間隔以秒為單位。

預設值: 30

--name --trigger-name -n

觸發程式名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。