Správa kanálu pomocí Azure CLI
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ů:
- az pipelines run: Spuštění existujícího kanálu
- az pipelines update: Aktualizace existujícího kanálu
- az pipelines show: Zobrazení podrobností o existujícím kanálu
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 Rozhraním příkazového řádku Azure DevOps.
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
- větev: Název větve, ve které má být spuštění kanálu zařazeno do fronty, například refs/heads/main.
- commit-id: Commit-id, na kterém se má spuštění kanálu zařadit do fronty.
- folder-path: Cesta ke složce kanálu. Výchozí je složka na kořenové úrovni.
- id: Povinný argument, pokud není zadán název . ID kanálu do fronty.
- name: Povinný argument, pokud id není zadáno, ale je ignorováno, pokud je ID zadáno. Název kanálu do fronty
- otevřít: 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í příkazu
az devops configure -d organization=ORG_URL
. Vyžaduje se, pokud není nakonfigurováno jako výchozí nebo převzato pomocígit config
. Příklad:--org https://dev.azure.com/MyOrganizationName/
. - project: Název nebo ID projektu. Výchozí projekt můžete nakonfigurovat pomocí
az devops configure -d project=NAME_OR_ID
příkazu . Vyžaduje se, pokud není nakonfigurováno jako výchozí nebo převzato pomocígit config
. - variables:Mezery oddělené dvojice "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 příkazem az pipelines update . Pokud chcete začít, přečtěte si téma Začínáme s Rozhraním příkazového řádku Azure DevOps.
az pipelines update [--branch]
[--description]
[--id]
[--name]
[--new-folder-path]
[--new-name]
[--org]
[--project]
[--queue-id]
[--yaml-path]
Parametry
- větev: Název větve, ve které se má nakonfigurovat spuštění kanálu, například refs/heads/main.
- description: Nový popis kanálu.
- id: Povinný argument, pokud není zadán název . ID kanálu, který se má aktualizovat.
- name: Povinný argument, pokud id není zadáno. Název kanálu, který se má aktualizovat.
- new-folder-path: Nová úplná cesta ke složce, do které je kanál přesunut, například user1/production_pipelines.
- new-name: Nový aktualizovaný název kanálu.
- org: Adresa URL organizace Azure DevOps. Výchozí organizaci můžete nakonfigurovat pomocí příkazu
az devops configure -d organization=ORG_URL
. Vyžaduje se, pokud není nakonfigurováno jako výchozí nebo převzato pomocígit config
. Příklad:--org https://dev.azure.com/MyOrganizationName/
. - project: Název nebo ID projektu. Výchozí projekt můžete nakonfigurovat pomocí
az devops configure -d project=NAME_OR_ID
příkazu . Vyžaduje se, pokud není nakonfigurováno jako výchozí nebo převzato pomocígit config
. - queue-id: ID fronty fondu agentů, ve kterém se má kanál spustit.
- yaml-path: Cesta k souboru yaml kanálu v úložišti.
Mezi globální parametry patří debug
, help
, query
only-show-errors
, , 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 příkazem az pipelines show . Pokud chcete začít, přečtěte si téma Začínáme s Rozhraním příkazového řádku Azure DevOps.
az pipelines show [--folder-path]
[--id]
[--name]
[--open]
[--org]
[--project]
[--query-examples]
[--subscription]
Parametry
- folder-path: Cesta ke složce kanálu. Výchozí je složka na kořenové úrovni.
- id: Povinný argument, pokud není zadán název . ID kanálu pro zobrazení podrobností
- name: Povinný argument, pokud není zadán název , ale při zadaném ID se ignoruje. Název kanálu pro zobrazení podrobností
- otevřít: Otevřete stránku souhrnu kanálu ve webovém prohlížeči.
- org: Adresa URL organizace Azure DevOps. Výchozí organizaci můžete nakonfigurovat pomocí příkazu
az devops configure -d organization=ORG_URL
. Vyžaduje se, pokud není nakonfigurováno jako výchozí nebo převzato pomocígit config
. Příklad:--org https://dev.azure.com/MyOrganizationName/
. - project: Název nebo ID projektu. Výchozí projekt můžete nakonfigurovat pomocí
az devops configure -d project=NAME_OR_ID
příkazu . Vyžaduje se, pokud není nakonfigurováno jako výchozí nebo převzato pomocígit config
. - Příklady dotazů: Doporučte řetězec JMESPath.
- předplatné: Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí příkazu
az account set -s NAME_OR_ID
.
Příklad
Následující příkaz zobrazí podrobnosti o 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 můžete přečíst další informace o konfiguraci kanálů v jazyce podle vašeho výběru:
Časté otázky
Návody programově vytvořit kanál sestavení?
Referenční informace k rozhraní REST API: Vytvoření kanálu sestavení
Poznámka
Sestavení a kanály můžete také spravovat z příkazového řádku nebo skriptů pomocí rozhraní příkazového řádku Azure Pipelines CLI.
Můžu v Azure DevOps Services spustit několik 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ějí 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 k zadání jednoho ID verze nebo 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.
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro