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

az repos pr

注意

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

管理拉取请求。

命令

名称 说明 类型 状态
az repos pr checkout

如果不存在本地更改,请在本地签出 PR 源分支。

扩展 GA
az repos pr create

创建拉取请求。

扩展 GA
az repos pr list

列出拉取请求。

扩展 GA
az repos pr policy

管理拉取请求策略。

扩展 GA
az repos pr policy list

列出拉取请求的策略。

扩展 GA
az repos pr policy queue

对拉取请求的策略进行评估排队。

扩展 GA
az repos pr reviewer

管理拉取请求审阅者。

扩展 GA
az repos pr reviewer add

将一个或多个审阅者添加到拉取请求。

扩展 GA
az repos pr reviewer list

列出拉取请求的审阅者。

扩展 GA
az repos pr reviewer remove

从拉取请求中删除一个或多个审阅者。

扩展 GA
az repos pr set-vote

对拉取请求进行投票。

扩展 GA
az repos pr show

获取拉取请求的详细信息。

扩展 GA
az repos pr update

更新拉取请求。

扩展 GA
az repos pr work-item

管理与拉取请求关联的工作项。

扩展 GA
az repos pr work-item add

将一个或多个工作项链接到拉取请求。

扩展 GA
az repos pr work-item list

列出拉取请求的链接工作项。

扩展 GA
az repos pr work-item remove

从拉取请求取消链接一个或多个工作项。

扩展 GA

az repos pr checkout

如果不存在本地更改,请在本地签出 PR 源分支。

az repos pr checkout --id
                     [--remote-name]

必需参数

--id

拉取请求的 ID。

可选参数

--remote-name

针对其引发 PR 的 git remote 的名称。

默认值: origin
全局参数
--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 repos pr create

创建拉取请求。

az repos pr create [--auto-complete {false, true}]
                   [--bypass-policy {false, true}]
                   [--bypass-policy-reason]
                   [--delete-source-branch {false, true}]
                   [--description]
                   [--detect {false, true}]
                   [--draft {false, true}]
                   [--labels]
                   [--merge-commit-message]
                   [--open]
                   [--optional-reviewers]
                   [--org]
                   [--project]
                   [--repository]
                   [--required-reviewers]
                   [--source-branch]
                   [--squash {false, true}]
                   [--target-branch]
                   [--title]
                   [--transition-work-items {false, true}]
                   [--work-items]

可选参数

--auto-complete

将拉取请求设置为在所有策略已通过且源分支可合并到目标分支时自动完成。

接受的值: false, true
默认值: False
--bypass-policy

绕过所需的策略(如果有),并在合并后完成拉取请求。

接受的值: false, true
默认值: False
--bypass-policy-reason

绕过所需策略的原因。

--delete-source-branch

在拉取请求完成后删除源分支,并将其合并到目标分支中。

接受的值: false, true
默认值: False
--description -d

新拉取请求的说明。 可以包括 markdown。 发送到此参数的每个值将是一个新行。 例如:--description“First Line”“Second Line”。

--detect

自动检测组织。

接受的值: false, true
--draft

使用此标志在草稿/工作模式下创建拉取请求。

接受的值: false, true
--labels

与拉取请求关联的标签。 空格分隔。

--merge-commit-message

合并提交时显示的消息。

--open

在 Web 浏览器中打开拉取请求。

默认值: False
--optional-reviewers --reviewers

要作为可选审阅者包含在新拉取请求上的其他用户或组。 空格分隔。

--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 配置进行选取,则为必需。

--repository -r

要在其中创建拉取请求的存储库的名称或 ID。

--required-reviewers

要作为新拉取请求的所需审阅者包含的其他用户或组。 空格分隔。

--source-branch -s

源分支的名称。 示例:“dev”。

--squash

合并到目标分支时,对源分支中的提交执行 Squash 操作。

接受的值: false, true
默认值: False
--target-branch -t

目标分支的名称。 如果未指定,则默认为目标存储库的默认分支。

--title

新拉取请求的标题。

--transition-work-items

将链接到拉取请求的任何工作项转换为下一个逻辑状态。 (例如活动 -> 已解决)。

接受的值: false, true
默认值: False
--work-items

要链接到新拉取请求的工作项的 ID。 空格分隔。

全局参数
--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 repos pr list

列出拉取请求。

az repos pr list [--creator]
                 [--detect {false, true}]
                 [--include-links]
                 [--org]
                 [--project]
                 [--repository]
                 [--reviewer]
                 [--skip]
                 [--source-branch]
                 [--status {abandoned, active, all, completed}]
                 [--target-branch]
                 [--top]

可选参数

--creator

将结果限制为此用户创建的拉取请求。

--detect

自动检测组织。

接受的值: false, true
--include-links

包括每个拉取请求的链接。

默认值: 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 配置进行选取,则为必需。

--repository -r

存储库的名称或 ID。

--reviewer

将结果限制为此用户是审阅者的拉取请求。

--skip

要跳过的拉取请求数。

--source-branch -s

将结果限制为源自此源分支的拉取请求。

--status

将结果限制为具有此状态的拉取请求。

接受的值: abandoned, active, all, completed
--target-branch -t

将结果限制为面向此分支的拉取请求。

--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 repos pr set-vote

对拉取请求进行投票。

az repos pr set-vote --id
                     --vote {approve, approve-with-suggestions, reject, reset, wait-for-author}
                     [--detect {false, true}]
                     [--org]

必需参数

--id

拉取请求的 ID。

--vote

拉取请求的新投票值。

接受的值: approve, approve-with-suggestions, reject, reset, wait-for-author

可选参数

--detect

自动检测组织。

接受的值: false, true
--org --organization

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

全局参数
--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 repos pr show

获取拉取请求的详细信息。

az repos pr show --id
                 [--detect {false, true}]
                 [--open]
                 [--org]

必需参数

--id

拉取请求的 ID。

可选参数

--detect

自动检测组织。

接受的值: false, true
--open

在 Web 浏览器中打开拉取请求。

默认值: False
--org --organization

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

全局参数
--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 repos pr update

更新拉取请求。

az repos pr update --id
                   [--auto-complete {false, true}]
                   [--bypass-policy {false, true}]
                   [--bypass-policy-reason]
                   [--delete-source-branch {false, true}]
                   [--description]
                   [--detect {false, true}]
                   [--draft {false, true}]
                   [--merge-commit-message]
                   [--org]
                   [--squash {false, true}]
                   [--status {abandoned, active, completed}]
                   [--title]
                   [--transition-work-items {false, true}]

必需参数

--id

拉取请求的 ID。

可选参数

--auto-complete

将拉取请求设置为在所有策略已通过且源分支可合并到目标分支时自动完成。

接受的值: false, true
--bypass-policy

绕过所需的策略(如果有),并在合并后完成拉取请求。

接受的值: false, true
--bypass-policy-reason

绕过所需策略的原因。

--delete-source-branch

在拉取请求完成后删除源分支,并将其合并到目标分支中。

接受的值: false, true
--description -d

拉取请求的新说明。 可以包括 markdown。 发送到此参数的每个值将是一个新行。 例如:--description“First Line”“Second Line”。

--detect

自动检测组织。

接受的值: false, true
--draft

发布 PR 或转换为草稿模式。

接受的值: false, true
--merge-commit-message

合并提交时显示的消息。

--org --organization

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

--squash

合并到目标分支时,对源分支中的提交执行 Squash 操作。

接受的值: false, true
--status

设置拉取请求的新状态。

接受的值: abandoned, active, completed
--title

拉取请求的新标题。

--transition-work-items

将链接到拉取请求的任何工作项转换为下一个逻辑状态。 (例如活动 -> 已解决)。

接受的值: false, true
全局参数
--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 获取完整的调试日志。