az repos pr

參考

注意

此參考是 Azure CLI 的 azure-devops 延伸模組的一部分（2.30.0 版或更高版本）。擴充功能會在您第一次執行 az repos pr 命令時自動安裝。深入了解擴充功能。

管理提取要求。

命令

名稱	Description	類型	狀態
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

提取要求的標識碼。

選擇性參數

--remote-name

引發PR的 git 遠端名稱。

預設值: origin

全域參數

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

在網頁瀏覽器中開啟提取要求。

預設值: False

--optional-reviewers --reviewers

要包含在新提取要求上做為選擇性檢閱者的其他使用者或群組。以空格分隔。

--org --organization

Azure DevOps 組織 URL。您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/。

--project -p

項目的名稱或識別碼。您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。如果未設定為預設，或透過 git 組態挑選，則為必要專案。

--repository -r

要用來建立提取要求之存放庫的名稱或標識碼。

--required-reviewers

要包含在新提取要求上作為必要檢閱者的其他使用者或群組。以空格分隔。

--source-branch -s

來源分支的名稱。範例：“dev”。

--squash

合併至目標分支時，將來源分支中的認可壓縮。

接受的值: false, true

預設值: False

--target-branch -t

目標分支的名稱。如果未指定，則會預設為目標存放庫的預設分支。

--title

新提取要求的標題。

--transition-work-items

將連結至提取要求的任何工作項目轉換為下一個邏輯狀態。（例如作用中 -> 已解決）。

接受的值: false, true

預設值: False

--work-items

要連結至新提取要求之工作項目的標識碼。以空格分隔。

全域參數

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

針對每個提取要求包含_links。

預設值: False

--org --organization

--project -p

項目的名稱或識別碼。您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。如果未設定為預設，或透過 git 組態挑選，則為必要專案。

--repository -r

存放庫的名稱或標識碼。

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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

提取要求的標識碼。

--vote

提取要求的新投票值。

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

選擇性參數

--detect

自動偵測組織。

接受的值: false, true

--org --organization

全域參數

--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 repos pr show

取得提取要求的詳細數據。

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

必要參數

--id

提取要求的標識碼。

選擇性參數

--detect

自動偵測組織。

接受的值: false, true

--open

在網頁瀏覽器中開啟提取要求。

預設值: False

--org --organization

全域參數

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

提取要求的標識碼。

選擇性參數

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

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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az repos pr

命令

az repos pr checkout

必要參數

選擇性參數

az repos pr create

選擇性參數

az repos pr list

選擇性參數

az repos pr set-vote

必要參數

選擇性參數

az repos pr show

必要參數

選擇性參數

az repos pr update

必要參數

選擇性參數

其他資源