Share via


az synapse trigger

管理 Synapse 的觸發程式。

命令

名稱 Description 類型 狀態
az synapse trigger create

建立觸發程式。

核心 GA
az synapse trigger delete

刪除觸發程式。

核心 GA
az synapse trigger get-event-subscription-status

取得觸發程式的事件訂閱狀態。

核心 GA
az synapse trigger list

列出觸發程式。

核心 GA
az synapse trigger set

更新現有的觸發程式。

核心 已取代
az synapse trigger show

取得觸發程式。

核心 GA
az synapse trigger start

啟動觸發程式。

核心 GA
az synapse trigger stop

停止觸發程式。

核心 GA
az synapse trigger subscribe-to-event

訂閱事件觸發程式至事件。

核心 GA
az synapse trigger unsubscribe-from-event

取消訂閱事件觸發程式的事件。

核心 GA
az synapse trigger update

更新現有的觸發程式。

核心 GA
az synapse trigger wait

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

核心 GA

az synapse trigger create

建立觸發程式。

az synapse trigger create --file
                          --name
                          --workspace-name
                          [--no-wait]

範例

建立觸發程式。 請注意在檔案路徑前面新增 「@」 作為 JSON 字串等複雜引數的最佳做法。

az synapse trigger create --workspace-name testsynapseworkspace \
  --name testtrigger --file @"path/trigger.json"

必要參數

--file

屬性可以使用語法或 JSON 字串,從 JSON 檔案 @{path} 提供。

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger delete

刪除觸發程式。

az synapse trigger delete --name
                          --workspace-name
                          [--no-wait]
                          [--yes]

範例

刪除觸發程式。

az synapse trigger delete --workspace-name testsynapseworkspace \
  --name testtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: False
--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 synapse trigger get-event-subscription-status

取得觸發程式的事件訂閱狀態。

az synapse trigger get-event-subscription-status --name
                                                 --workspace-name

範例

取得觸發程式的事件訂閱狀態。

az synapse trigger get-event-subscription-status --workspace-name testsynapseworkspace \
  --name eventtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-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 synapse trigger list

列出觸發程式。

az synapse trigger list --workspace-name

範例

列出觸發程式。

az synapse trigger list --workspace-name testsynapseworkspace

必要參數

--workspace-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 synapse trigger set

已被取代

此命令已被取代,並將在未來版本中移除。 請改用 'update'。

更新現有的觸發程式。

az synapse trigger set --file
                       --name
                       --workspace-name
                       [--no-wait]

範例

更新現有的觸發程式。 請注意在檔案路徑前面新增 「@」 作為 JSON 字串等複雜引數的最佳做法。

az synapse trigger set --workspace-name testsynapseworkspace \
  --name testtrigger --file @"path/trigger.json"

必要參數

--file

屬性可以使用語法或 JSON 字串,從 JSON 檔案 @{path} 提供。

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger show

取得觸發程式。

az synapse trigger show --name
                        --workspace-name

範例

取得觸發程式。

az synapse trigger show --workspace-name testsynapseworkspace \
  --name testtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-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 synapse trigger start

啟動觸發程式。

az synapse trigger start --name
                         --workspace-name
                         [--no-wait]

範例

啟動觸發程式。

az synapse trigger start --workspace-name testsynapseworkspace \
  --name testtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger stop

停止觸發程式。

az synapse trigger stop --name
                        --workspace-name
                        [--no-wait]

範例

停止觸發程式。

az synapse trigger stop --workspace-name testsynapseworkspace \
  --name testtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger subscribe-to-event

訂閱事件觸發程式至事件。

az synapse trigger subscribe-to-event --name
                                      --workspace-name
                                      [--no-wait]

範例

訂閱事件觸發程式至事件。

az synapse trigger subscribe-to-event --workspace-name testsynapseworkspace \
  --name eventtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger unsubscribe-from-event

取消訂閱事件觸發程式的事件。

az synapse trigger unsubscribe-from-event --name
                                          --workspace-name
                                          [--no-wait]

範例

取消訂閱事件觸發程式的事件。

az synapse trigger unsubscribe-from-event --workspace-name testsynapseworkspace \
  --name eventtrigger

必要參數

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger update

更新現有的觸發程式。

az synapse trigger update --file
                          --name
                          --workspace-name
                          [--no-wait]

範例

更新現有的觸發程式。 請注意在檔案路徑前面新增 「@」 作為 JSON 字串等複雜引數的最佳做法。

az synapse trigger update --workspace-name testsynapseworkspace \
  --name testtrigger --file @"path/trigger.json"

必要參數

--file

屬性可以使用語法或 JSON 字串,從 JSON 檔案 @{path} 提供。

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 synapse trigger wait

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

az synapse trigger wait --name
                        --workspace-name
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

必要參數

--name -n

觸發程式名稱。

--workspace-name

工作區名稱。

選擇性參數

--created

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

預設值: False
--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--interval

輪詢間隔以秒為單位。

預設值: 30
--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 來取得完整偵錯記錄。