使用 Azure CLI 管理管道
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020
可以使用以下命令 az pipelines
管理组织中的管道:
- az pipelines run:运行现有管道
- az pipelines update:更新现有管道
- az pipelines show:显示现有管道的详细信息
这些命令需要要管理的管道的名称或 ID。 可以使用 az pipelines list 命令获取管道的 ID。
若要开始,请参阅 Azure DevOps CLI 入门。
运行管道
可以使用 az pipelines run 命令将 (运行) 现有管道排队。
az pipelines run [--branch]
[--commit-id]
[--folder-path]
[--id]
[--name]
[--open]
[--org]
[--project]
[--variables]
参数
- branch:管道运行要排队的分支的名称,例如 refs/heads/main。
- commit-id:管道运行要排队的 Commit-id。
- folder-path:管道的文件夹路径。 默认值为根级别文件夹。
- id:如果未提供 name,则此参数是必需的。 要排队的管道的 ID。
- name:如果未提供 ID ,则为必需;如果提供 ID ,则忽略。 要排队的管道的名称。
- open:在 Web 浏览器中打开管道结果页。
- org:Azure DevOps 组织 URL。 可以使用
az devops configure -d organization=ORG_URL
配置默认组织。 如果未配置为默认值或通过git config
选取,则此参数是必需的。 示例:--org https://dev.azure.com/MyOrganizationName/
。 - project:项目的名称或 ID。 可以使用
az devops configure -d project=NAME_OR_ID
配置默认项目。 如果未配置为默认值或通过git config
选取,则此参数是必需的。 - variables:要设置的变量的空格分隔的“name=value”对。
示例
以下命令在分支管道中运行名为 myGithubname.pipelines-java 的 管道 ,并按表格式显示结果。
az pipelines run --name myGithubname.pipelines-java --branch pipeline --output table
Run ID Number Status Result Pipeline ID Pipeline Name Source Branch Queued Time Reason
-------- ---------- ---------- -------- ------------- --------------------------- --------------- -------------------------- --------
123 20200123.2 notStarted 12 myGithubname.pipelines-java pipeline 2020-01-23 11:55:56.633450 manual
更新管道
可以使用 az pipelines update 命令更新现有管道 。 若要开始,请参阅 Azure DevOps CLI 入门。
az pipelines update [--branch]
[--description]
[--id]
[--name]
[--new-folder-path]
[--new-name]
[--org]
[--project]
[--queue-id]
[--yaml-path]
参数
- branch:要配置管道运行的分支的名称,例如 refs/heads/main。
- description:管道的新说明。
- id:如果未提供 name,则此参数是必需的。 要更新的管道的 ID。
- name:如果未提供 ID ,则为必需。 要更新的管道的名称。
- new-folder-path:管道要移动到的文件夹的新完整路径,例如 user1/production_pipelines。
- new-name:管道的新更新名称。
- org:Azure DevOps 组织 URL。 可以使用
az devops configure -d organization=ORG_URL
配置默认组织。 如果未配置为默认值或通过git config
选取,则此参数是必需的。 示例:--org https://dev.azure.com/MyOrganizationName/
。 - project:项目的名称或 ID。 可以使用
az devops configure -d project=NAME_OR_ID
配置默认项目。 如果未配置为默认值或通过git config
选取,则此参数是必需的。 - queue-id:需要在其中运行管道的代理池的队列 ID。
- yaml-path:存储库中管道 yaml 文件的路径。
全局参数包括 debug
、 help
、 only-show-errors
、 query
、 output
和 verbose
。
提示
还可以使用全局参数,例如 --output
。
参数 --output
适用于所有命令。 table 值以友好格式显示输出。 有关详细信息,请参阅 Azure CLI 命令的输出格式。
示例
以下命令使用新的名称和说明更新 ID 为 12 的管道,并用表格式显示结果。
az pipelines update --id 12 --description "rename pipeline" --new-name updatedname.pipelines-java --output table
ID Name Status Default Queue
---- -------------------------- -------- ------------------
12 updatedname.pipelines-java enabled Hosted Ubuntu 1604
显示管道
可以使用 az pipelines show 命令查看现有管道的详细信息。 若要开始,请参阅 Azure DevOps CLI 入门。
az pipelines show [--folder-path]
[--id]
[--name]
[--open]
[--org]
[--project]
[--query-examples]
[--subscription]
参数
- folder-path:管道的文件夹路径。 默认值为根级别文件夹。
- id:如果未提供 name,则此参数是必需的。 用于显示详细信息的管道的 ID。
- name:如果未提供 名称 ,则为必需;如果提供 ID ,则忽略。 要显示详细信息的管道的名称。
- open:在 Web 浏览器中打开管道摘要页。
- org:Azure DevOps 组织 URL。 可以使用
az devops configure -d organization=ORG_URL
配置默认组织。 如果未配置为默认值或通过git config
选取,则此参数是必需的。 示例:--org https://dev.azure.com/MyOrganizationName/
。 - project:项目的名称或 ID。 可以使用
az devops configure -d project=NAME_OR_ID
配置默认项目。 如果未配置为默认值或通过git config
选取,则此参数是必需的。 - 查询示例:推荐 JMESPath 字符串。
- subscription:订阅的名称或 ID。 可以使用
az account set -s NAME_OR_ID
配置默认订阅。
示例
以下命令显示 ID 为 12 的管道的详细信息,并返回表格式的结果。
az pipelines show --id 12 --output table
ID Name Status Default Queue
---- -------------------------- -------- ------------------
12 updatedname.pipelines-java enabled Hosted Ubuntu 1604
后续步骤
可以 自定义管道, 或详细了解如何使用所选语言配置管道:
FAQ
如何以编程方式创建生成管道?
注意
还可以使用 Azure Pipelines CLI 从命令行或脚本管理生成和生成管道。
是否可以使用单个命令在 Azure DevOps Services 中运行多个管道?
目前,Azure CLI 和 Azure API 不提供从命令行运行多个管道的命令。 可以使用 Azure CLI 命令 列出所有管道和定义,并提供 单个 发布或生成 ID 作为参数。 所有命令都设计为适用于独立管道的独立运行,并且它们需要仅允许一个唯一值的唯一 ID 请求。 若要了解管道触发器,请参阅 指定触发管道的事件。
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈