YAML-sémareferenciák az Azure Pipelineshoz

Az Azure Pipelines YAML-sémareferenciája a YAML-folyamatok részletes referenciája, amely felsorolja az összes támogatott YAML-szintaxist és azok rendelkezésre álló lehetőségeit.

YAML-folyamat létrehozásához kezdje a folyamat definíciójával. A YAML-folyamatok létrehozásával kapcsolatos további információkért lásd : A folyamat testreszabása.

A YAML-sémahivatkozás nem fedi le a feladatokat. A feladatokkal kapcsolatos további információkért lásd az Azure Pipelines-tevékenységek indexét.

Definíciók

Csővezeték
A folyamatok egy vagy több szakaszból áll, amelyek egy CI/CD-folyamatot írnak le. A folyamatdefiníció tartalmazza az olyan gyökérszintű tulajdonságok dokumentációját, mint a name.

Csővezeték
A folyamat egy vagy több feladat, amely egy CI/CD-folyamatot ír le.

Kiterjeszti
Kiterjeszt egy folyamatot egy sablon használatával.

Munkahelyek
Meghatározza azokat a feladatokat, amelyek egy szakasz munkáját alkotják.

Munkahelyek
Meghatározza a folyamat munkáját alkotó feladatokat.

jobs.deployment
Az üzembehelyezési feladat egy speciális típusú feladat. Ez a környezeten egymást követő futtatás lépéseinek gyűjteménye.

jobs.deployment.environment
Célkörnyezet neve és opcionálisan egy erőforrásnév az üzembehelyezési előzmények rögzítéséhez; format: environment-name.resource-name.

jobs.deployment.strategy
Az üzembe helyezés végrehajtási stratégiája.

jobs.deployment.strategy.canary
Canary üzembehelyezési stratégia.

jobs.deployment.strategy.rolling
Működés közbeni üzembe helyezési stratégia.

jobs.deployment.strategy.runOnce
RunOnce üzembehelyezési stratégia.

jobs.job
A feladat egy ügynök vagy egy kiszolgálón futtatott lépések gyűjteménye.

jobs.job.container
Tárolóerőforrás neve.

jobs.job.strategy
A feladat végrehajtási stratégiája.

jobs.job.uses
A feladathoz szükséges erőforrások, amelyekre még nem hivatkoztak.

jobs.template
A sablonban definiált feladatok halmaza.

Paraméterek
Megadja a folyamatnak átadott futtatókörnyezeti paramétereket.

parameters.parameter
Folyamatsablon paraméterei.

Medence
A folyamat feladatához használandó készlet.

pool.demands
Igények (privát készlethez).

pr
Lekéréses kérelem eseményindítója.

Erőforrások
Az erőforrások a folyamat által használt buildeket, adattárakat, folyamatokat és egyéb erőforrásokat határozzák meg.

resources.builds
A folyamat által hivatkozott builderőforrások listája.

resources.builds.build
Egy builderőforrás, amely futtatásból származó összetevőkre hivatkozik.

resources.containers
Tárolórendszerképek listája.

resources.containers.container
Tárolórendszerképre való hivatkozáshoz használt tárolóerőforrás.

resources.containers.container.trigger
Adja meg, hogy nincs-e letiltható, igaz értékre van kapcsolva az összes képcímkén való aktiváláshoz, vagy használja a teljes szintaxist az alábbi példákban leírtak szerint.

resources.packages
Csomagerőforrások listája.

resources.packages.package
Egy NuGet- vagy npm GitHub-csomagra való hivatkozáshoz használt csomagerőforrás.

resources.pipelines
Folyamaterőforrások listája.

resources.pipelines.pipeline
Egy folyamaterőforrás.

resources.pipelines.pipeline.trigger
A letiltandó egyiket sem adja meg, igaz értékre az összes ág belefoglalásához, vagy használja a teljes szintaxist az alábbi példákban leírtak szerint.

resources.pipelines.pipeline.trigger.branches
Futtatás indításához belefoglalandó vagy kizárandó ágak.

resources.repositories
Az adattár erőforrásainak listája.

resources.repositories.repository
A rendszer egy adattárerőforrást használ egy további adattárra való hivatkozáshoz a folyamatban.

resources.webhooks
A webhookok listája.

resources.webhooks.webhook
A webhook-erőforrások lehetővé teszik a folyamat egy külső szolgáltatással való integrálását a munkafolyamat automatizálásához.

resources.webhooks.webhook.filters
Eseményindító-szűrők listája.

resources.webhooks.webhook.filters.filter
Webhook erőforrás-eseményindító szűrője.

Menetrend
Az ütemezések listája határozza meg a folyamat ütemezett eseményindítóit.

schedules.cron
Az ütemezett eseményindító meghatározza az ágak felépítésének ütemezését.

Szakaszában
A szakaszok kapcsolódó feladatok gyűjteményei.

stages.stage
A fázisok kapcsolódó feladatok gyűjteményei.

stages.template
Szakaszokat definiálhat egy fájlban, és többször is használhatja más fájlokban.

Lépéseket
A lépések a feladatokat alkotó műveletek lineáris sorozatai.

steps.bash
Szkriptet futtat a Bashben Windows, macOS és Linux rendszeren.

steps.checkout
Konfigurálja, hogy a folyamat hogyan használja ki a forráskódot.

steps.download
Letölti az aktuális futtatáshoz vagy egy másik, folyamaterőforrásként társított Azure Pipeline-ból társított összetevőket.

steps.downloadBuild
Letölti a buildösszetevőket.

steps.getPackage
Letölt egy csomagot egy csomagkezelési hírcsatornából az Azure Artifactsben vagy Azure DevOps Server.

steps.powershell
Szkriptet futtat Windows PowerShell (Windows rendszeren) vagy pwsh (Linux és macOS) használatával.

steps.publish
Közzétesz (feltölt) egy fájlt vagy mappát folyamatösszetevőként, amelyet más feladatok és folyamatok felhasználhatnak.

steps.pwsh
Szkriptet futtat a PowerShell Core-ban Windows, macOS és Linux rendszeren.

steps.reviewApp
A letöltések dinamikusan létrehoznak egy erőforrást egy üzembe helyezési fázisszolgáltató alatt.

steps.script
Szkriptet futtat a windowsos cmd.exe és a Bash használatával más platformokon.

steps.task
Futtat egy feladatot.

steps.template
Definiáljon egy lépéskészletet egy fájlban, és használja azt többször egy másik fájlban.

Cél
A feladatok végrehajtási környezetben futnak, amely az ügynök gazdagépe vagy egy tároló.

target.settableVariables
A beállítható változókra vonatkozó korlátozások.

Ravaszt
Folyamatos integrációs (leküldéses) eseményindító.

Változók
Változók definiálása név-érték párok használatával.

variables.group
Változócsoportból származó változók hivatkozása.

variables.name
Definiáljon változókat névvel és teljes szintaxissal.

variables.template
Változók definiálása sablonban.

Támogató definíciók

Megjegyzés

A támogató definíciók nem közvetlenül egy folyamatban való használatra szolgálnak. A segéddefiníciók csak más definíciók részeként használhatók, és hivatkozás céljából itt találhatók.

deployHook
Az alkalmazás üzembe helyezésének lépéseinek futtatására szolgál.

includeExcludeFilters
A belefoglalandó vagy kizárandó elemek listája.

includeExcludeStringFilters
Belefoglalandó vagy kizárandó elemek.

mountReadOnly
A csak olvasható kötetek csatlakoztatásához az alapértelmezett érték hamis.

onFailureHook
A visszaállítási műveletek vagy a törlés lépéseinek futtatására szolgál.

onSuccessHook
A visszaállítási műveletek vagy a törlés lépéseinek futtatására szolgál.

onSuccessOrFailureHook
A visszaállítási műveletek vagy a törlés lépéseinek futtatására szolgál.

postRouteTrafficHook
A forgalom irányítását követő lépések futtatására szolgál. Ezek a feladatok általában meghatározott időközönként figyelik a frissített verzió állapotát.

preDeployHook
Olyan lépések futtatására szolgál, amelyek inicializálják az erőforrásokat az alkalmazás üzembe helyezése előtt.

routeTrafficHook
A frissített verzió felé történő forgalmat kiszolgáló lépések futtatására szolgál.

Munkaterület
Munkaterület beállításai az ügynökön.

YAML-sémadokumentációk konvenciók

A YAML-sémahivatkozás az Azure Pipelines YAML-folyamatainak részletes referencia-útmutatója. Tartalmaz egy katalógust az összes támogatott YAML-képességről és az elérhető lehetőségekről.

Íme a YAML-sémahivatkozásban használt szintaxiskonvenciák.

  • A bal oldalon : található a folyamatdefiníciókban használt szó szerinti kulcsszó.
  • A jobb oldalon : egy adattípus található. Az adattípus lehet primitív típus, például sztring vagy a hivatkozás más részén definiált gazdag szerkezetre mutató hivatkozás.
  • A jelölés [adattípusa] az említett definíciótípus tömbje. Például [ string ] sztringek tömbje.
  • A jelölés {adattípus adattípusa:} az egyik adattípus egy másikhoz való leképezését jelzi. Például { string: string } a sztringek sztringekhez való leképezése.
  • A szimbólum | azt jelzi, hogy a kulcsszóhoz több adattípus is elérhető. Például azt jelenti, job | template hogy egy feladatdefiníció vagy egy sablonhivatkozás engedélyezve van.

Lásd még

Ez a referencia egy Azure Pipelines YAML-fájl sémáját ismerteti. A YAML alapjainak megismeréséhez lásd: Learn YAML in Y Minutes (YAML megismerése Y perc alatt). Az Azure Pipelines nem támogatja az összes YAML-funkciót. A nem támogatott funkciók közé tartoznak a horgonyok, az összetett kulcsok és a készletek. A szabványos YAML-sel ellentétben az Azure Pipelines attól is függ, hogy a leképezés első kulcsaként lát-e stage, job, , taskvagy egy feladatikont script .