Správa kanálu pomocí Azure CLI

  • Článek

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

Kanály ve vaší organizaci můžete spravovat pomocí těchto az pipelines příkazů:

Tyto příkazy vyžadují název nebo ID kanálu, který chcete spravovat. ID kanálu můžete získat pomocí příkazu az pipelines list .

Pokud chcete začít, přečtěte si téma Začínáme s Azure DevOps CLI.

Spuštění kanálu

Existující kanál můžete zařadit do fronty (spustit) pomocí příkazu az pipelines run .

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

Parametry

  • branch: Název větve, na které se má spustit kanál, zařadí do fronty, například refs/heads/main.
  • commit-id: ID potvrzení, na kterém má být spuštěn kanál zařazen do fronty.
  • cesta ke složce: Cesta ke složce kanálu. Výchozí hodnota je složka kořenové úrovně.
  • ID: Povinné, pokud není zadaný název . ID kanálu do fronty.
  • name: Povinný argument, pokud není zadané ID, ale pokud je ID zadané, bude ignorováno. Název kanálu, který se má zařadit do fronty
  • open: Otevřete stránku výsledků kanálu ve webovém prohlížeči.
  • org: Adresa URL organizace Azure DevOps Výchozí organizaci můžete nakonfigurovat pomocí .az devops configure -d organization=ORG_URL Požadováno, pokud není nakonfigurováno jako výchozí nebo vyzvednuto pomocí git config. Příklad: --org https://dev.azure.com/MyOrganizationName/.
  • projekt: Název nebo ID projektu. Výchozí projekt můžete nakonfigurovat pomocí az devops configure -d project=NAME_OR_ID. Požadováno, pokud není nakonfigurováno jako výchozí nebo vyzvednuto pomocí git config.
  • proměnné: Mezera oddělená páry name=value pro proměnné, které chcete nastavit.

Příklad

Následující příkaz spustí kanál myGithubname.pipelines-java v kanálu větve a zobrazí výsledek ve formátu tabulky.

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

Aktualizace kanálu

Existující kanál můžete aktualizovat pomocí příkazu az pipelines update . Pokud chcete začít, přečtěte si téma Začínáme s Azure DevOps CLI.

az pipelines update [--branch]
                    [--description]
                    [--id]
                    [--name]
                    [--new-folder-path]
                    [--new-name]
                    [--org]
                    [--project]
                    [--queue-id]
                    [--yaml-path]

Parametry

  • branch: Název větve, na které se má nakonfigurovat spuštění kanálu, například refs/heads/main.
  • popis: Nový popis kanálu.
  • ID: Povinné, pokud není zadaný název . ID kanálu, který se má aktualizovat.
  • name: Povinné, pokud není zadané ID . Název kanálu, který se má aktualizovat.
  • new-folder-path: Nová úplná cesta ke složce, do které se kanál přesune, například user1/production_pipelines.
  • new-name: New updated name of the pipeline.
  • org: Adresa URL organizace Azure DevOps Výchozí organizaci můžete nakonfigurovat pomocí .az devops configure -d organization=ORG_URL Požadováno, pokud není nakonfigurováno jako výchozí nebo vyzvednuto pomocí git config. Příklad: --org https://dev.azure.com/MyOrganizationName/.
  • projekt: Název nebo ID projektu. Výchozí projekt můžete nakonfigurovat pomocí az devops configure -d project=NAME_OR_ID. Požadováno, pokud není nakonfigurováno jako výchozí nebo vyzvednuto pomocí git config.
  • queue-id: ID fronty fondu agentů, kde se kanál musí spustit.
  • yaml-path: Cesta k souboru yaml kanálu v úložišti.

Mezi globální parametry patří debug, , helponly-show-errors, query, output, a verbose.

Tip

Existují také globální parametry, které můžete použít například --output. Parametr --output je k dispozici pro všechny příkazy. Hodnota tabulky představuje výstup v popisné podobě. Další informace najdete v tématu Formáty výstupu pro příkazy Azure CLI.

Příklad

Následující příkaz aktualizuje kanál s ID 12 novým názvem a popisem a zobrazí výsledek ve formátu tabulky.

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

Zobrazit kanál

Podrobnosti o existujícím kanálu můžete zobrazit pomocí příkazu az pipelines show . Pokud chcete začít, přečtěte si téma Začínáme s Azure DevOps CLI.

az pipelines show [--folder-path]
                  [--id]
                  [--name]
                  [--open]
                  [--org]
                  [--project]
                  [--query-examples]
                  [--subscription]

Parametry

  • cesta ke složce: Cesta ke složce kanálu. Výchozí hodnota je složka kořenové úrovně.
  • ID: Povinné, pokud není zadaný název . ID kanálu pro zobrazení podrobností
  • name: Povinný argument, pokud není zadaný název, ale pokud je zadané ID, bude ignorováno. Název kanálu, který zobrazí podrobnosti.
  • open: Otevřete stránku se souhrnem kanálu ve webovém prohlížeči.
  • org: Adresa URL organizace Azure DevOps Výchozí organizaci můžete nakonfigurovat pomocí .az devops configure -d organization=ORG_URL Požadováno, pokud není nakonfigurováno jako výchozí nebo vyzvednuto pomocí git config. Příklad: --org https://dev.azure.com/MyOrganizationName/.
  • projekt: Název nebo ID projektu. Výchozí projekt můžete nakonfigurovat pomocí az devops configure -d project=NAME_OR_ID. Požadováno, pokud není nakonfigurováno jako výchozí nebo vyzvednuto pomocí git config.
  • Příklady dotazů: Doporučte vám řetězec JMESPath.
  • předplatné: Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Příklad

Následující příkaz zobrazí podrobnosti kanálu s ID 12 a vrátí výsledek ve formátu tabulky.

az pipelines show --id 12 --output table

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

Další kroky

Kanál si můžete přizpůsobit nebo si přečíst další informace o konfiguraci kanálů v jazyce podle vašeho výběru:

Často kladené dotazy

Návody programově vytvořit kanál buildu?

Referenční informace k rozhraní REST API: Vytvoření kanálu buildu

Poznámka:

Pomocí azure Pipelines CLI můžete také spravovat buildy a kanály sestavení z příkazového řádku nebo skriptů.

Můžu v Azure DevOps Services spustit více kanálů pomocí jednoho příkazu?

Rozhraní příkazového řádku Azure a rozhraní API Azure v současné době nenabízí příkazy, které spouští více kanálů z příkazového řádku. Příkazy Azure CLI můžete použít k výpisu všech kanálů a definic a zadání jediné verze nebo ID sestavení jako parametru. Všechny příkazy jsou navržené tak, aby fungovaly pro nezávislá spuštění nezávislých kanálů a vyžadují jedinečné požadavky ID, které umožňují pouze jednu jedinečnou hodnotu. Další informace o aktivačních událostech kanálu najdete v tématu Určení událostí, které aktivují kanály.

Návody přeskočit fázi spuštění kanálu?

Pomocí příkazu můžete pomocí az rest run pipeline rozhraní REST API Azure DevOps přeskočit fázi spuštění kanálu pomocí parametru stagesToSkip .

Příklad:

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

Další informace najdete v referenčních informacích k rozhraní REST API služby Azure DevOps Services.