Referenční informace ke schématu YAML pro Azure Pipelines

Referenční informace o schématu YAML pro Azure Pipelines jsou podrobnými referenčními informacemi pro kanály YAML, které uvádějí všechny podporované syntaxe YAML a jejich dostupné možnosti.

Pokud chcete vytvořit kanál YAML, začněte definicí kanálu . Další informace o vytváření kanálů YAML najdete v tématu Přizpůsobení kanálu.

Referenční informace o schématu YAML se nepopisuje na úlohy. Další informace o úlohách najdete v indexu úloh Azure Pipelines.

Definice

Potrubí
Kanál je jedna nebo více fází, které popisují proces CI/CD. Definice kanálu obsahuje dokumentaci pro vlastnosti kořenové úrovně, jako je name.

Rozšiřuje
Rozšiřuje kanál pomocí šablony.

Úlohy
Určuje úlohy, které tvoří práci fáze.

jobs.deployment
Úloha nasazení je speciální typ úlohy. Jedná se o kolekci kroků, které se mají v prostředí spouštět postupně.

jobs.deployment.environment
Název cílového prostředí a volitelně název prostředku pro záznam historie nasazení; format: environment-name.resource-name.

jobs.deployment.strategy
Strategie provádění pro toto nasazení.

jobs.deployment.strategy.canary
Strategie nasazení kanárů.

jobs.deployment.strategy.rolling
Strategie postupného nasazení.

jobs.deployment.strategy.runOnce
Strategie nasazení RunOnce.

jobs.job
Úloha je kolekce kroků spuštěných agentem nebo na serveru.

jobs.job.container
Název prostředku kontejneru.

jobs.job.strategy
Strategie provádění pro tuto úlohu

jobs.job.uses
Všechny prostředky vyžadované touto úlohou, na které se ještě neodkazuje.

jobs.template
Sada úloh definovaných v šabloně.

Parametry
Určuje parametry modulu runtime předané kanálu.

parameters.parameter
Parametry šablony kanálu.

Bazén
Který fond se má použít pro úlohu kanálu.

pool.demands
Požadavky (pro soukromý fond)

pr
Trigger žádosti o přijetí změn

Zdroje
Prostředky určují sestavení, úložiště, kanály a další prostředky používané kanálem.

resources.builds
Seznam prostředků sestavení, na které kanál odkazuje

resources.builds.build
Prostředek sestavení, který se používá k odkazům na artefakty ze spuštění.

resources.containers
Seznam imagí kontejnerů

resources.containers.container
Prostředek kontejneru, který se používá k odkazu na image kontejneru.

resources.containers.container.trigger
Zadejte hodnotu none, která se má zakázat, true, aby se aktivovala u všech značek obrázků, nebo použijte úplnou syntaxi, jak je popsáno v následujících příkladech.

resources.packages
Seznam prostředků balíčků

resources.packages.package
Prostředek balíčku, který se používá k odkazu na balíček NuGet nebo npm GitHub.

resources.pipelines
Seznam prostředků kanálu

resources.pipelines.pipelines.pipeline
Prostředek kanálu.

resources.pipelines.pipelines.trigger
Zadejte hodnotu none, která se má zakázat, true, pokud chcete zahrnout všechny větve, nebo použijte úplnou syntaxi, jak je popsáno v následujících příkladech.

resources.pipelines.pipeline.trigger.branches
Větve, které se mají zahrnout nebo vyloučit pro aktivaci spuštění.

resources.repositories
Seznam prostředků úložiště

resources.repositories.repository
Prostředek úložiště se používá k odkazování na další úložiště ve vašem kanálu.

resources.webhooks
Seznam webhooků

resources.webhooks.webhook
Prostředek webhooku umožňuje integrovat kanál s externí službou za účelem automatizace pracovního postupu.

resources.webhooks.webhook.filters
Seznam filtrů triggerů

resources.webhooks.webhook.filters.filter
Filtr triggeru prostředku Webhooku.

Plány
Seznam plánů určuje naplánované aktivační události pro kanál.

schedules.cron
Naplánovaná aktivační událost určuje plán, podle kterého jsou větve vytvořeny.

Fázích
Fáze jsou kolekce souvisejících úloh.

stages.stage
Fáze je kolekce souvisejících úloh.

stages.template
Můžete definovat sadu fází v jednom souboru a použít ji vícekrát v jiných souborech.

Kroky
Kroky jsou lineární posloupností operací, které tvoří úlohu.

steps.bash
Spustí skript v Bash ve Windows, macOS a Linuxu.

steps.checkout
Nakonfigurujte způsob, jakým kanál kontroluje zdrojový kód.

steps.download
Stahuje artefakty přidružené k aktuálnímu spuštění nebo z jiného kanálu Azure, který je přidružený jako prostředek kanálu.

steps.downloadBuild
Stahuje artefakty sestavení.

steps.getPackage
Stáhne balíček z informačního kanálu pro správu balíčků v Azure Artifacts nebo Azure DevOps Server.

steps.powershell
Spustí skript pomocí Windows PowerShell (ve Windows) nebo pwsh (Linux a macOS).

steps.publish
Publikuje (nahraje) soubor nebo složku jako artefakt kanálu, který můžou využívat jiné úlohy a kanály.

steps.pwsh
Spustí skript v PowerShellu Core ve Windows, macOS a Linuxu.

steps.reviewApp
Soubory ke stažení vytvoří prostředek dynamicky v rámci poskytovatele fáze nasazení.

steps.script
Spustí skript pomocí cmd.exe ve Windows a Bash na jiných platformách.

steps.task
Spustí úlohu.

steps.template
Definujte sadu kroků v jednom souboru a několikrát ji použijte v jiném souboru.

Cíl
Úlohy se spouští v kontextu spuštění, což je buď hostitel agenta, nebo kontejner.

target.settableVariables
Omezení proměnných, které lze nastavit

Aktivační událost
Trigger kontinuální integrace (nabízení).

Proměnné
Definujte proměnné pomocí párů název/hodnota.

variables.group
Odkaz na proměnné ze skupiny proměnných.

variables.name
Definujte proměnné pomocí názvu a úplné syntaxe.

variables.template
Definování proměnných v šabloně

Podpůrné definice

Poznámka

Podpůrné definice nejsou určeny k použití přímo v kanálu. Podpůrné definice se používají pouze jako součást jiných definic a jsou zde uvedeny pro referenci.

deployHook
Používá se ke spuštění kroků, které nasazují vaši aplikaci.

includeExcludeFilters
Seznamy položek, které se mají zahrnout nebo vyloučit.

includeExcludeStringFilters
Položky, které chcete zahrnout nebo vyloučit.

mountReadOnly
Svazky pro připojení jen pro čtení, výchozí hodnota je nepravda.

onFailureHook
Slouží ke spuštění kroků pro akce vrácení zpět nebo vyčištění.

onSuccessHook
Slouží ke spuštění kroků pro akce vrácení zpět nebo vyčištění.

onSuccessOrFailureHook
Slouží ke spuštění kroků pro akce vrácení zpět nebo vyčištění.

postRouteTrafficHook
Slouží ke spuštění kroků po směrování provozu. Tyto úlohy obvykle monitorují stav aktualizované verze po definovaný interval.

preDeployHook
Používá se ke spuštění kroků, které inicializují prostředky před spuštěním nasazení aplikace.

routeTrafficHook
Slouží ke spuštění kroků, které obsluhují provoz do aktualizované verze.

Pracovního prostoru
Možnosti pracovního prostoru v agentu.

Konvence dokumentace ke schématu YAML

Referenční informace o schématu YAML je podrobný referenční průvodce kanály YAML služby Azure Pipelines. Obsahuje katalog všech podporovaných funkcí YAML a dostupných možností.

Tady jsou konvence syntaxe používané v referenčních informacích ke schématu YAML.

• Nalevo od : je klíčové slovo literálu používaného v definicích kanálu.
• Napravo od : je datový typ. Datový typ může být primitivní typ, jako je řetězec , nebo odkaz na bohatou strukturu definovanou jinde v tomto odkazu.
• Datový typ] notace [ označuje pole uvedeného typu definice. Například [ string ] je pole řetězců.
• Datový typ}: zápisu { označuje mapování jednoho datového typu na jiný. Například { string: string } je mapování řetězců na řetězce.
• Symbol | označuje, že pro klíčové slovo je k dispozici více datových typů. Například znamená, job | template že je povolená buď definice úlohy, nebo odkaz na šablonu.

Viz také

Tento odkaz se zabývá schématem souboru YAML služby Azure Pipelines. Základní informace o YAML najdete v tématu Výuka YAML v minutách Y. Azure Pipelines nepodporuje všechny funkce YAML. Mezi nepodporované funkce patří ukotvení, komplexní klíče a sady. Na rozdíl od standardního YAML závisí služba Azure Pipelines také na tom, že se jako první klíč v mapování zobrazí stageklávesa , jobtask, nebo zástupce script úlohy.