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

az pipelines

注意

此参考是 Azure CLI（版本 2.30.0 或更高版本）的 azure-devops 扩展的一部分。 该扩展将在首次运行 az pipelines 命令时自动安装。 详细了解扩展。

管理 Azure Pipelines。

此命令组是 azure-devops 扩展的一部分。

命令

名称	说明	类型	状态
az pipelines agent	管理代理。	分机	GA
az pipelines agent list	获取池中的代理列表。	分机	GA
az pipelines agent show	显示代理详细信息。	分机	GA
az pipelines build	管理生成。	扩展	GA
az pipelines build cancel	如果生成正在运行，则取消。	分机	GA
az pipelines build definition	管理生成定义。	扩展	GA
az pipelines build definition list	列出生成定义。	分机	GA
az pipelines build definition show	获取生成定义的详细信息。	分机	GA
az pipelines build list	列出生成结果。	扩展	GA
az pipelines build queue	请求（队列）生成。	分机	GA
az pipelines build show	获取生成的详细信息。	分机	GA
az pipelines build tag	管理生成标记。	分机	GA
az pipelines build tag add	为生成添加标记（s）。	分机	GA
az pipelines build tag delete	删除生成标记。	扩展	GA
az pipelines build tag list	获取生成标记。	扩展	GA
az pipelines create	创建新的 Azure Pipeline（基于 YAML）。	扩展	GA
az pipelines delete	删除管道。	分机	GA
az pipelines folder	管理用于整理管道的文件夹。	分机	GA
az pipelines folder create	创建文件夹。	分机	GA
az pipelines folder delete	删除文件夹。	分机	GA
az pipelines folder list	列出所有文件夹。	扩展	GA
az pipelines folder update	更新文件夹名称或说明。	扩展	GA
az pipelines list	列出管道。	分机	GA
az pipelines pool	管理代理池。	分机	GA
az pipelines pool list	列出代理池。	分机	GA
az pipelines pool show	显示代理池详细信息。	分机	GA
az pipelines queue	管理代理队列。	分机	GA
az pipelines queue list	列出代理队列。	分机	GA
az pipelines queue show	显示代理队列的详细信息。	分机	GA
az pipelines release	管理发布。	分机	GA
az pipelines release create	请求（创建）发布。	分机	GA
az pipelines release definition	管理发布定义。	扩展	GA
az pipelines release definition list	列出发布定义。	扩展	GA
az pipelines release definition show	获取发布定义的详细信息。	分机	GA
az pipelines release list	列出发布结果。	分机	GA
az pipelines release show	获取发布的详细信息。	分机	GA
az pipelines run	队列（运行）管道。	分机	GA
az pipelines runs	管理管道运行。	分机	GA
az pipelines runs artifact	管理管道运行工件。	分机	GA
az pipelines runs artifact download	下载管道项目。	分机	GA
az pipelines runs artifact list	列出与运行关联的项目。	分机	GA
az pipelines runs artifact upload	上传管道项目。	分机	GA
az pipelines runs list	列出项目中的管道运行。	分机	GA
az pipelines runs show	显示管道运行的详细信息。	扩展	GA
az pipelines runs tag	管理管道运行标记。	分机	GA
az pipelines runs tag add	为管道运行添加标记（s）。	扩展	GA
az pipelines runs tag delete	删除管道运行标记。	分机	GA
az pipelines runs tag list	获取管道运行的标记。	扩展	GA
az pipelines show	获取管道的详细信息。	分机	GA
az pipelines update	更新管道。	扩展	GA
az pipelines variable	管理管道变量。	扩展	GA
az pipelines variable-group	管理变量组。	分机	GA
az pipelines variable-group create	创建变量组。	分机	GA
az pipelines variable-group delete	删除变量组。	分机	GA
az pipelines variable-group list	列出变量组。	分机	GA
az pipelines variable-group show	显示变量组详细信息。	扩展	GA
az pipelines variable-group update	更新变量组。	分机	GA
az pipelines variable-group variable	管理变量组中的变量。	扩展	GA
az pipelines variable-group variable create	将变量添加到变量组。	分机	GA
az pipelines variable-group variable delete	从变量组中删除变量。	扩展	GA
az pipelines variable-group variable list	列出变量组中的变量。	分机	GA
az pipelines variable-group variable update	更新变量组中的变量。	分机	GA
az pipelines variable create	将变量添加到管道。	分机	GA
az pipelines variable delete	从管道中删除变量。	分机	GA
az pipelines variable list	列出管道中的变量。	分机	GA
az pipelines variable update	更新管道中的变量。	扩展	GA

az pipelines create

创建新的 Azure Pipeline（基于 YAML）。

az pipelines create --name
                    [--branch]
                    [--description]
                    [--detect {false, true}]
                    [--folder-path]
                    [--org]
                    [--project]
                    [--queue-id]
                    [--repository]
                    [--repository-type {github, tfsgit}]
                    [--service-connection]
                    [--skip-first-run {false, true}]
                    [--yaml-path]

示例

从本地 检查out 存储库上下文创建 Azure Pipeline

Repository name/url (--repository), type (--repository-type) and branch name (--branch) will be detected from the local git repository
az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'

使用克隆 URL 为 Github 上托管的存储库创建 Azure Pipeline

az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository https://github.com/SampleOrg/SampleRepo --branch master

为 Github 组织 SampleOrg 上托管的存储库创建 Azure Pipeline，存储库名称 SampleRepo

az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository SampleOrg/SampleRepoName --branch master --repository-type github

为同一项目中 Azure 存储库中托管的存储库创建 Azure Pipeline

az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository SampleRepoName --branch master --repository-type tfsgit

为存储库创建包含已检查管道 yaml 的存储库的 Azure Pipeline

Service connection required for non Azure Repos can be optionally provided in the command to run it non interatively
az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
--repository https://github.com/SampleOrg/SampleRepo --branch master --yml-path azure-pipelines.yml [--service-connection SERVICE_CONNECTION]

必需参数

--name

新管道的名称。

可选参数

--branch

将为其配置管道的分支名称。 如果省略，将从本地存储库自动检测它。

--description

新管道的说明。

--detect

自动检测组织。

接受的值: false, true

--folder-path

需要在其中创建管道的文件夹的路径。 默认值为根文件夹。 例如“user1/test_pipelines”。

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

--queue-id

可用代理池中队列的 ID。 如果未指定，将自动检测。

--repository

需要为其配置管道的存储库。 可以是 Git 存储库的克隆 URL，也可以是 Azure Repos 或 Owner/RepoName 的存储库名称（对于 GitHub 存储库）。 如果省略，将从本地 git 存储库的远程 URL 自动检测它。 如果名称提及而不是 url，则还需要 --repository-type 参数。

--repository-type

存储库的类型。 如果省略，将从本地存储库的远程 URL 自动检测它。 适用于 Azure Repos 的“tfsgit”，用于 GitHub 存储库的“github”。

接受的值: github, tfsgit

--service-connection

为 GitHub 存储库存储库创建的服务连接的 ID。 使用命令 az devops service-endpoint -h 创建/列出service_connections。 Azure Repos 不需要。

--skip-first-run --skip-run

指定此标志以防止命令触发第一次运行。 如果跳过运行，命令将返回管道，否则它将输出管道运行。

接受的值: false, true

--yaml-path --yml-path

存储库中管道 yaml 文件的路径（如果存储库中已存在 yaml）。

全局参数

--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 pipelines delete

删除管道。

az pipelines delete --id
                    [--detect {false, true}]
                    [--org]
                    [--project]
                    [--yes]

必需参数

--id

管道的 ID。

可选参数

--detect

自动检测组织。

接受的值: false, true

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

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

列出管道。

az pipelines list [--detect {false, true}]
                  [--folder-path]
                  [--name]
                  [--org]
                  [--project]
                  [--query-order {ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None}]
                  [--repository]
                  [--repository-type {bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol}]
                  [--top]

可选参数

--detect

自动检测组织。

接受的值: false, true

--folder-path

如果指定，则筛选到此文件夹下的定义。

--name

将结果限制为具有此名称或以此名称开头的管道。 示例：“FabCI”或“Fab*”。

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

--query-order

结果的顺序。

接受的值: ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None

--repository

将结果限制为与此存储库关联的管道。

--repository-type

将结果限制为与此存储库类型关联的管道。 必须传递“repository”参数以及此参数。

接受的值: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol

--top

要列出的最大管道数。

全局参数

--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 pipelines run

队列（运行）管道。

az pipelines run [--branch]
                 [--commit-id]
                 [--detect {false, true}]
                 [--folder-path]
                 [--id]
                 [--name]
                 [--open]
                 [--org]
                 [--parameters]
                 [--project]
                 [--variables]

可选参数

--branch

要对其运行管道的分支进行排队的分支的名称。 示例：refs/heads/master 或 master 或 refs/pull/1/merge 或 refs/tags/tag。

--commit-id

管道运行要排队的提交 ID。

--detect

自动检测组织。

接受的值: false, true

--folder-path

管道的文件夹路径。 默认值为根级别文件夹。

--id

要排队的管道的 ID。 如果未提供 --name，则为必需。

--name

要排队的管道的名称。 如果提供了 --id，则忽略。

--open

在 Web 浏览器中打开管道结果页。

默认值: False

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--parameters

要设置的参数的空格分隔“name=value”对。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

--variables

要设置的变量的空格分隔“name=value”对。

全局参数

--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 pipelines show

获取管道的详细信息。

az pipelines show [--detect {false, true}]
                  [--folder-path]
                  [--id]
                  [--name]
                  [--open]
                  [--org]
                  [--project]

可选参数

--detect

自动检测组织。

接受的值: false, true

--folder-path

管道的文件夹路径。 默认值为根级别文件夹。

--id

管道的 ID。

--name

管道的名称。 如果提供了 --id，则忽略。

--open

在 Web 浏览器中打开管道摘要页。

默认值: False

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

全局参数

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

更新管道。

az pipelines update --id
                    [--branch]
                    [--description]
                    [--detect {false, true}]
                    [--new-folder-path]
                    [--new-name]
                    [--org]
                    [--project]
                    [--queue-id]
                    [--yaml-path]

必需参数

--id

要更新的管道的 ID。

可选参数

--branch

将为其配置管道的分支名称。

--description

管道的新说明。

--detect

自动检测组织。

接受的值: false, true

--new-folder-path

要将管道移动到的文件夹的新完整路径。例如“user1/production_pipelines”。

--new-name

管道的新更新名称。

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。

--queue-id

运行管道的代理池的队列 ID。

--yaml-path --yml-path

存储库中管道 yaml 文件的路径。

全局参数

--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 获取完整的调试日志。