az synapse pipeline

管理 Synapse 的管線。

命令

名稱	Description	類型	狀態
az synapse pipeline create	建立管線。	核心	GA
az synapse pipeline create-run	建立管線的執行。	核心	GA
az synapse pipeline delete	刪除管線。	核心	GA
az synapse pipeline list	列出管線。	核心	GA
az synapse pipeline set	更新現有的管線。	核心	已取代
az synapse pipeline show	取得管線。	核心	GA
az synapse pipeline update	更新現有的管線。	核心	GA

az synapse pipeline create

建立管線。

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

範例

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

az synapse pipeline create --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.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 pipeline create-run

建立管線的執行。

az synapse pipeline create-run --name
                               --workspace-name
                               [--is-recovery {false, true}]
                               [--parameters]
                               [--reference-pipeline-run-id]
                               [--start-activity-name]

範例

Pipelines_CreateRun

az synapse pipeline create-run --workspace-name testsynapseworkspace --name "myPipeline" \
  --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}"

必要參數

--name -n

管線名稱。

--workspace-name

工作區名稱。

選擇性參數

--is-recovery

復原模式旗標。 如果復原模式設定為 true，則指定的參考管線執行和新的執行將會分組在相同的 groupId 下。

接受的值: false, true

--parameters

管線執行的參數。 可以使用語法或 JSON 字串，從 JSON 檔案 @{path} 提供。

--reference-pipeline-run-id --run-id

用於重新執行的管線執行識別碼。 如果指定執行識別碼，則會使用指定回合的參數來建立新的執行。

--start-activity-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 pipeline delete

刪除管線。

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

範例

刪除管線。

az synapse pipeline delete --workspace-name testsynapseworkspace \
  --name testpipeline

必要參數

--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 pipeline list

列出管線。

az synapse pipeline list --workspace-name

範例

列出管線。

az synapse pipeline 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 pipeline set

已被取代

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

更新現有的管線。

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

範例

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

az synapse pipeline set --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.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 pipeline show

取得管線。

az synapse pipeline show --name
                         --workspace-name

範例

取得管線。

az synapse pipeline show --workspace-name testsynapseworkspace \
  --name testpipeline

必要參數

--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 pipeline update

更新現有的管線。

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

範例

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

az synapse pipeline update --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.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 來取得完整偵錯記錄。