YAML-schemareferens för Azure Pipelines

YAML-schemareferensen för Azure Pipelines är en detaljerad referens för YAML-pipelines som visar alla YAML-syntaxer som stöds och deras tillgängliga alternativ.

Om du vill skapa en YAML-pipeline börjar du med pipelinedefinitionen . Mer information om hur du skapar YAML-pipelines finns i Anpassa din pipeline.

YAML-schemareferensen omfattar inte uppgifter. Mer information om aktiviteter finns i Index för Azure Pipelines-uppgifter.

Definitioner

Rörledning
En pipeline är ett eller flera steg som beskriver en CI/CD-process. Pipelinedefinitionen innehåller dokumentationen för rotnivåegenskaper som name.

Sträcker sig
Utökar en pipeline med hjälp av en mall.

Jobb
Anger de jobb som utgör arbetet i en fas.

jobs.deployment
Ett distributionsjobb är en särskild typ av jobb. Det är en samling steg för att köra sekventiellt mot miljön.

jobs.deployment.environment
Målmiljönamn och eventuellt ett resursnamn för att registrera distributionshistoriken. format: environment-name.resource-name.

jobs.deployment.strategy
Körningsstrategi för den här distributionen.

jobs.deployment.strategy.canary
Strategi för kanariedistribution.

jobs.deployment.strategy.rolling
Strategi för löpande distribution.

jobs.deployment.strategy.runOnce
RunOnce-distributionsstrategi.

jobs.job
Ett jobb är en samling steg som körs av en agent eller på en server.

jobs.job.container
Namnet på containerresursen.

jobs.job.strategy
Körningsstrategi för det här jobbet.

jobs.job.uses
Alla resurser som krävs av det här jobbet som inte redan refereras.

jobs.template
En uppsättning jobb som definierats i en mall.

Parametrar
Anger de körningsparametrar som skickas till en pipeline.

parameters.parameter
Parametrar för pipelinemallar.

Pool
Vilken pool som ska användas för ett jobb i pipelinen.

pool.demands
Krav (för en privat pool).

pr
Utlösare för pull-begäran.

Resurser
Resurser anger byggen, lagringsplatser, pipelines och andra resurser som används av pipelinen.

resources.builds
Lista över byggresurser som refereras av pipelinen.

resources.builds.build
En byggresurs som används för att referera till artefakter från en körning.

resources.containers
Lista över containeravbildningar.

resources.containers.container
En containerresurs som används för att referera till en containeravbildning.

resources.containers.container.trigger
Ange ingen att inaktivera, sant att utlösa på alla bildtaggar eller använd den fullständiga syntaxen enligt beskrivningen i följande exempel.

resources.packages
Lista över paketresurser.

resources.packages.package
En paketresurs som används för att referera till ett NuGet- eller npm GitHub-paket.

resources.pipelines
Lista över pipelineresurser.

resources.pipelines.pipeline
En pipelineresurs.

resources.pipelines.pipeline.trigger
Ange ingen som ska inaktiveras, sant för att inkludera alla grenar eller använd den fullständiga syntaxen enligt beskrivningen i följande exempel.

resources.pipelines.pipeline.trigger.branches
Grenar som ska inkluderas eller exkluderas för att utlösa en körning.

resources.repositories
Lista över lagringsplatsresurser.

resources.repositories.repository
En lagringsplatsresurs används för att referera till ytterligare en lagringsplats i pipelinen.

resources.webhooks
Lista över webhooks.

resources.webhooks.webhook
Med en webhook-resurs kan du integrera din pipeline med en extern tjänst för att automatisera arbetsflödet.

resources.webhooks.webhook.filters
Lista över utlösarfilter.

resources.webhooks.webhook.filters.filter
Webhook-resursutlösarfilter.

Scheman
Listan scheman anger de schemalagda utlösarna för pipelinen.

schedules.cron
En schemalagd utlösare anger ett schema för vilka grenar som skapas.

Stadier
Faser är en samling relaterade jobb.

stages.stage
En fas är en samling relaterade jobb.

stages.template
Du kan definiera en uppsättning faser i en fil och använda den flera gånger i andra filer.

Steg
Steg är en linjär sekvens med åtgärder som utgör ett jobb.

steps.bash
Kör ett skript i Bash i Windows, macOS och Linux.

steps.checkout
Konfigurera hur pipelinen checkar ut källkoden.

steps.download
Laddar ned artefakter som är associerade med den aktuella körningen eller från en annan Azure Pipeline som är associerad som en pipelineresurs.

steps.downloadBuild
Laddar ned byggartefakter.

steps.getPackage
Laddar ned ett paket från ett pakethanteringsflöde i Azure Artifacts eller Azure DevOps Server.

steps.powershell
Kör ett skript med antingen Windows PowerShell (i Windows) eller pwsh (Linux och macOS).

steps.publish
Publicerar (laddar upp) en fil eller mapp som en pipelineartefakt som andra jobb och pipelines kan använda.

steps.pwsh
Kör ett skript i PowerShell Core i Windows, macOS och Linux.

steps.reviewApp
Nedladdningar skapar en resurs dynamiskt under en distributionsfasprovider.

steps.script
Kör ett skript med cmd.exe på Windows och Bash på andra plattformar.

steps.task
Kör en uppgift.

steps.template
Definiera en uppsättning steg i en fil och använd den flera gånger i en annan fil.

Mål
Aktiviteter körs i en körningskontext, som antingen är agentvärden eller en container.

target.settableVariables
Begränsningar för vilka variabler som kan anges.

Utlösa
Utlösare för kontinuerlig integrering (push).

Variabler
Definiera variabler med namn/värde-par.

variables.group
Referensvariabler från en variabelgrupp.

variables.name
Definiera variabler med namn och fullständig syntax.

variables.template
Definiera variabler i en mall.

Stöddefinitioner

Anteckning

Stöddefinitioner är inte avsedda att användas direkt i en pipeline. Stödjande definitioner används endast som en del av andra definitioner och ingår här som referens.

deployHook
Används för att köra steg som distribuerar ditt program.

includeExcludeFilters
Listor över objekt som ska inkluderas eller exkluderas.

includeExcludeStringFilters
Objekt som ska inkluderas eller exkluderas.

mountReadOnly
Volymer för att montera skrivskyddade, standardvärdet är falskt.

onFailureHook
Används för att köra steg för återställningsåtgärder eller rensning.

onSuccessHook
Används för att köra steg för återställningsåtgärder eller rensning.

onSuccessOrFailureHook
Används för att köra steg för återställningsåtgärder eller rensning.

postRouteTrafficHook
Används för att köra stegen när trafiken har dirigerats. Vanligtvis övervakar dessa uppgifter hälsotillståndet för den uppdaterade versionen för definierat intervall.

preDeployHook
Används för att köra steg som initierar resurser innan programdistributionen startar.

routeTrafficHook
Används för att köra steg som hanterar trafiken till den uppdaterade versionen.

Arbetsytan
Arbetsytealternativ för agenten.

Dokumentationskonventioner för YAML-schema

YAML-schemareferensen är en detaljerad referensguide till YAML-pipelines för Azure Pipelines. Den innehåller en katalog över alla YAML-funktioner som stöds och tillgängliga alternativ.

Här är syntaxkonventionerna som används i YAML-schemareferensen.

• Till vänster om : finns ett literal nyckelord som används i pipelinedefinitioner.
• Till höger om : är en datatyp. Datatypen kan vara en primitiv typ som sträng eller en referens till en omfattande struktur som definierats någon annanstans i den här referensen.
• Notationsdatatypen][ anger en matris med den nämnda definitionstypen. Är till exempel [ string ] en matris med strängar.
• Datatypen notationsdatatyp}:{ anger en mappning av en datatyp till en annan. Till exempel { string: string } är en mappning av strängar till strängar.
• Symbolen | anger att det finns flera tillgängliga datatyper för nyckelordet. Innebär till exempel job | template att antingen en jobbdefinition eller en mallreferens tillåts.

Se även

Den här referensen beskriver schemat för en AZURE Pipelines YAML-fil. Mer information om grunderna i YAML finns i Learn YAML in Y Minutes (Lär dig YAML i Y Minutes). Azure Pipelines stöder inte alla YAML-funktioner. Funktioner som inte stöds omfattar fästpunkter, komplexa nycklar och uppsättningar. Till skillnad från standard-YAML är Azure Pipelines beroende av att se stage, job, taskeller en uppgiftsgenväg som script den första nyckeln i en mappning.