使用 Azure CLI 管理管線

文章
06/21/2024

Azure DevOps Services |Azure DevOps Server 2022 |Azure DevOps Server 2020

您可以使用下列 az pipelines 命令來管理組織中的管線：

az pipelines run：執行現有的管線
az pipelines update：更新現有的管線
az pipelines show：顯示現有管線的詳細數據

這些命令需要您想要管理的管線名稱或標識碼。您可以使用 az pipelines list 命令來取得管線的識別碼。

執行管線

您可以使用 az pipelines run 命令，將現有的管線排入佇列（執行）。

az pipelines run [--branch]
                 [--commit-id]
                 [--folder-path]
                 [--id]
                 [--name]
                 [--open]
                 [--org]
                 [--project]
                 [--variables]

參數

branch：管線執行要排入佇列的分支名稱， 例如 refs/heads/main。
commit-id：管線執行要排入佇列的認可標識碼。
folder-path：管線的資料夾路徑。預設值為根層級資料夾。
id：如果未 提供名稱 ，則為必要項。要排入佇列之管線的標識碼。
name：如果未提供標識符，則為必要，但如果提供標識符，則會忽略。要排入佇列的管線名稱。
開啟：在網頁瀏覽器中開啟管線結果頁面。
組織：Azure DevOps 組織 URL。您可以使用來設定預設組織 az devops configure -d organization=ORG_URL。如果未設定為預設或使用 git config來挑選，則為必要項。範例：--org https://dev.azure.com/MyOrganizationName/。
專案：專案的名稱或識別碼。您可以使用來設定預設專案 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]

參數

分支：要設定管線執行所在的分支名稱， 例如 refs/heads/main。
描述：管線的新描述。
id：如果未 提供名稱 ，則為必要項。要更新之管線的標識碼。
name：如果未提供標識符，則為必要專案。要更新的管線名稱。
new-folder-path：將管線移至之資料夾的新完整路徑，例如 user1/production_pipelines。
new-name：管線的新更新名稱。
組織：Azure DevOps 組織 URL。您可以使用來設定預設組織 az devops configure -d organization=ORG_URL。如果未設定為預設或使用 git config來挑選，則為必要項。範例：--org https://dev.azure.com/MyOrganizationName/。
專案：專案的名稱或識別碼。您可以使用來設定預設專案 az devops configure -d project=NAME_OR_ID。如果未設定為預設或使用 git config來挑選，則為必要項。
queue-id：需要執行管線之代理程式集區的佇列標識碼。
yaml-path：存放庫中管線 yaml 檔案的路徑。

全域參數包括 debug、 help、 only-show-errors、、 query、 output 和 verbose。

提示

您也可以使用全域參數，例如 --output。參數 --output 適用於所有命令。 資料表值會以易記格式呈現輸出。如需詳細資訊，請參閱 Azure CLI 命令的輸出格式。

範例

下列命令會以新的名稱和描述來更新標識碼為 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：如果未提供名稱，則為必要專案，但如果提供標識符，則會忽略。要顯示詳細數據的管線名稱。
open：在網頁瀏覽器中開啟管線摘要頁面。
組織：Azure DevOps 組織 URL。您可以使用來設定預設組織 az devops configure -d organization=ORG_URL。如果未設定為預設或使用 git config來挑選，則為必要項。範例：--org https://dev.azure.com/MyOrganizationName/。
專案：專案的名稱或識別碼。您可以使用來設定預設專案 az devops configure -d project=NAME_OR_ID。如果未設定為預設或使用 git config來挑選，則為必要項。
查詢範例：建議您使用 JMESPath 字串。
訂用帳戶：訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

範例

下列命令會顯示標識碼為 12 的管線詳細數據，並以數據表格式傳回結果。

az pipelines show --id 12 --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

下一步

您可以自訂管線，或深入瞭解以您選擇的語言設定管線：

常見問題集

如何? 以程序設計方式建立組建管線？

REST API 參考：建立組建管線

注意

您也可以使用 Azure Pipelines CLI 從命令行或腳本管理組建和建置管線。

是否可以使用單一命令在 Azure DevOps Services 中執行多個管線？

目前，Azure CLI 和 Azure API 不提供從命令行執行多個管線的命令。您可以使用 Azure CLI 命令來列出所有管線和定義，並提供單一版本或組建識別碼作為參數。所有命令的設計都是為了獨立執行獨立管線而運作，而且它們需要唯一標識碼要求，只允許一個唯一值。若要瞭解管線觸發程式，請參閱指定觸發管線的事件。

如何? 略過管線執行中的階段嗎？

您可以使用 az rest 命令來使用 run pipeline Azure DevOps REST API，使用 stagesToSkip 參數略過管線執行中的階段。

例如：

az rest --method post `
    --uri https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1 `
    --body "{'stagesToSkip': [''], 'resources': {'repositories': {'self': {'refName': 'refs/heads/{branch}'}}}}" `
    --resource 499b84ac-1321-427f-aa17-267ca6975798

如需詳細資訊，請參閱 Azure DevOps Services REST API 參考。

分享方式：