Naslaginformatie over YAML-schema's voor Azure Pipelines

De YAML-schemareferentie voor Azure Pipelines is een gedetailleerde verwijzing voor YAML-pijplijnen waarin alle ondersteunde YAML-syntaxis en de beschikbare opties worden vermeld.

Als u een YAML-pijplijn wilt maken, begint u met de pijplijn definitie. Zie Uw pijplijn aanpassenvoor meer informatie over het bouwen van YAML-pijplijnen.

De YAML-schemareferentie heeft geen betrekking op taken. Zie de index Azure Pipelines-takenindexvoor meer informatie over taken.

Definities

pijplijn
Een pijplijn is een of meer fasen die een CI/CD-proces beschrijven. De pijplijndefinitie bevat de documentatie voor eigenschappen op hoofdniveau, zoals name.

uitbreiden
Breidt een pijplijn uit met behulp van een sjabloon.

taken
Hiermee geeft u de taken op waaruit het werk van een fase bestaat.

jobs.deployment
Een implementatietaak is een speciaal type taak. Het is een verzameling stappen voor het sequentieel uitvoeren van de omgeving.

jobs.deployment.environment
naam van de doelomgeving en eventueel een resourcenaam om de implementatiegeschiedenis vast te leggen; indeling: environment-name.resource-name.

jobs.deployment.strategy
uitvoeringsstrategie voor deze implementatie.

jobs.deployment.strategy.canary
canary-implementatiestrategie.

jobs.deployment.strategy.rolling
strategie voor rolling implementatie.

jobs.deployment.strategy.runOnce-
RunOnce Deployment-strategie.

jobs.job
Een taak is een verzameling stappen die worden uitgevoerd door een agent of op een server.

jobs.job.container
containerresourcenaam.

jobs.job.strategy
uitvoeringsstrategie voor deze taak.

jobs.job.gebruikt
Alle resources die vereist zijn voor deze taak waarnaar nog niet wordt verwezen.

jobs.template
een set taken die in een sjabloon zijn gedefinieerd.

parameters
Geeft de runtimeparameters op die worden doorgegeven aan een pijplijn.

parameters.parameter
pijplijnsjabloonparameters.

pool
Welke pool moet worden gebruikt voor een taak van de pijplijn.

pool.eisen
Eisen (voor een eigen zwembad).

pr-
pull-aanvraagtrigger.

resources
Resources specificeert builds, opslagplaatsen, pijplijnen en andere resources die door de pijplijn worden gebruikt.

resources.builds
lijst met build-resources waarnaar wordt verwezen door de pijplijn.

resources.builds.build
Een build-resource die wordt gebruikt om te verwijzen naar artefacten uit een uitvoering.

resources.containers
lijst met containerinstallatiekopieën.

resources.containers.container
een containerresource die wordt gebruikt om te verwijzen naar een containerinstallatiekopieën.

resources.containers.container.trigger
Geef niets op om uit te schakelen, waar om te activeren voor alle afbeeldingstags of gebruik de volledige syntaxis, zoals beschreven in de volgende voorbeelden.

resources.packages
lijst met pakketbronnen.

resources.packages.package
Een pakketresource die wordt gebruikt om te verwijzen naar een NuGet- of npm GitHub-pakket.

resources.pipelines
lijst met pijplijnbronnen.

resources.pipelines.pipeline
een pijplijnresource.

resources.pipelines.pipeline.trigger
Geef geen op om uit te schakelen, waar om alle vertakkingen op te nemen of gebruik de volledige syntaxis, zoals beschreven in de volgende voorbeelden.

resources.pipelines.pipeline.trigger.branches
Vertakkingen die moeten worden opgenomen of uitgesloten voor het activeren van een uitvoering.

resources.repositorys
lijst met opslagplaatsresources.

resources.repositorys.repository
Een opslagplaatsresource wordt gebruikt om te verwijzen naar een extra opslagplaats in uw pijplijn.

resources.webhooks
lijst met webhooks.

resources.webhooks.webhook
Een webhookresource kunt u uw pijplijn integreren met een externe service om de werkstroom te automatiseren.

resources.webhooks.webhook.filters
Lijst met triggerfilters.

resources.webhooks.webhook.filters.filter
filter voor resourcetrigger voor webhook.

planningen
De lijst met planningen geeft de geplande triggers voor de pijplijn op.

schedules.cron
Een geplande trigger geeft een schema op waarop vertakkingen worden gebouwd.

fasen
fasen zijn een verzameling gerelateerde taken.

stages.stage
Een fase is een verzameling gerelateerde taken.

stages.template
U kunt een set fasen in het ene bestand definiëren en meerdere keren gebruiken in andere bestanden.

stappen
Stappen vormen een lineaire reeks bewerkingen waaruit een taak bestaat.

steps.bash-
voert een script uit in Bash in Windows, macOS en Linux.

steps.checkout
Configureer hoe de pijplijn broncode uitcheckt.

steps.download
downloadt artefacten die zijn gekoppeld aan de huidige uitvoering of vanuit een andere Azure-pijplijn die is gekoppeld als een pijplijnresource.

steps.downloadBuild
Build-artefacten downloaden.

steps.getPackage
downloadt een pakket uit een pakketbeheerfeed in Azure Artifacts of Azure DevOps Server.

steps.powershell-
voert een script uit met Windows PowerShell (op Windows) of pwsh (Linux en macOS).

steps.publish
publiceert (uploadt) een bestand of map als een pijplijnartefact dat andere taken en pijplijnen kunnen gebruiken.

steps.pwsh
voert een script uit in PowerShell Core in Windows, macOS en Linux.

steps.reviewApp-
Downloads maakt dynamisch een resource onder een implementatiefaseprovider.

steps.script
voert een script uit met behulp van cmd.exe in Windows en Bash op andere platforms.

steps.task
voert een taak uit.

steps.template
Definieer een reeks stappen in het ene bestand en gebruik deze meerdere keren in een ander bestand.

doeldoel
taken worden uitgevoerd in een uitvoeringscontext. Dit is de agenthost of een container.

target.settableVariables
Beperkingen voor welke variabelen kunnen worden ingesteld.

trigger
trigger voor continue integratie (push).

variabelen
Variabelen definiëren met behulp van naam-/waardeparen.

variables.group
Verwijzingsvariabelen uit een variabelegroep.

variables.name
Variabelen definiëren met de naam en volledige syntaxis.

variables.template
Variabelen definiëren in een sjabloon.

Ondersteunende definities

Notitie

Ondersteunende definities zijn niet bedoeld voor gebruik rechtstreeks in een pijplijn. Ondersteunende definities worden alleen gebruikt als onderdeel van andere definities en worden hier ter referentie opgenomen.

deployHook-
Wordt gebruikt om stappen uit te voeren waarmee uw toepassing wordt geïmplementeerd.

includeExcludeFilters
lijsten met items die moeten worden opgenomen of uitgesloten.

includeExcludeStringFilters
items die moeten worden opgenomen of uitgesloten.

mountReadOnly-
volumes om alleen-lezen te koppelen, is de standaardwaarde onwaar.

onFailureHook
Wordt gebruikt om stappen uit te voeren voor terugdraaiacties of opschonen.

onSuccessHook-
Wordt gebruikt om stappen uit te voeren voor terugdraaiacties of opschonen.

onSuccessOrFailureHook
Wordt gebruikt om stappen uit te voeren voor terugdraaiacties of opschonen.

postRouteTrafficHook
Wordt gebruikt om de stappen uit te voeren nadat het verkeer is gerouteerd. Normaal gesproken bewaken deze taken de status van de bijgewerkte versie voor een gedefinieerd interval.

preDeployHook-
Wordt gebruikt om stappen uit te voeren waarmee resources worden geïnitialiseerd voordat de implementatie van de toepassing wordt gestart.

routeTrafficHook
Wordt gebruikt om stappen uit te voeren die het verkeer naar de bijgewerkte versie leveren.

werkruimte
werkruimteopties op de agent.

Documentatieconventies voor YAML-schema's

De YAML-schemareferentie is een gedetailleerde referentiehandleiding voor YAML-pijplijnen van Azure Pipelines. Het bevat een catalogus met alle ondersteunde YAML-mogelijkheden en de beschikbare opties.

Dit zijn de syntaxisconventies die worden gebruikt in de YAML-schemareferentie.

• Links van : staat een letterlijk trefwoord dat wordt gebruikt in pijplijndefinities.
• Rechts van : is een gegevenstype. Het gegevenstype kan een primitief type zijn, zoals tekenreeks of een verwijzing naar een uitgebreide structuur die elders in deze verwijzing is gedefinieerd.
• De notatie [gegevenstype] geeft een matrix van het genoemde definitietype aan. [ string ] is bijvoorbeeld een matrix met tekenreeksen.
• De notatie {gegevenstype:gegevenstype} geeft een toewijzing van het ene gegevenstype aan het andere aan. { string: string } is bijvoorbeeld een toewijzing van tekenreeksen aan tekenreeksen.
• Het symbool | geeft aan dat er meerdere gegevenstypen beschikbaar zijn voor het trefwoord. job | template betekent bijvoorbeeld dat een taakdefinitie of sjabloonreferentie is toegestaan.

Zie ook

In deze verwijzing wordt het schema van een YAML-bestand van Azure Pipelines behandeld. Zie Learn YAML in Y Minutesvoor meer informatie over de basisprincipes van YAML. Azure Pipelines biedt geen ondersteuning voor alle YAML-functies. Niet-ondersteunde functies zijn ankers, complexe sleutels en sets. In tegenstelling tot standaard YAML zijn Azure Pipelines afhankelijk van het zien van stage, job, taskof een taaksnelkoppeling zoals script als de eerste sleutel in een toewijzing.