通过

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

az synapse pipeline

  • 参考

管理 Synapse 的管道。

命令

名称 说明 类型 Status
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

订阅的名称或 ID。 可以使用 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

用于重新运行的管道运行 ID。 如果指定了运行 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。