Naslaginformatie over YAML-schema's voor Azure Pipelines

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

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

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

Definities

Pijpleiding
Een pijplijn bestaat uit een of meer fasen waarin een CI/CD-proces wordt beschreven. De pijplijndefinitie bevat de documentatie voor eigenschappen op basisniveau, zoals name.

Breidt
Breidt een pijplijn uit met behulp van een sjabloon.

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

jobs.deployment
Een implementatietaak is een speciaal type taak. Het is een verzameling stappen die sequentieel moeten worden uitgevoerd op basis van de omgeving.

jobs.deployment.environment
Naam van de doelomgeving en eventueel een resourcenaam om de implementatiegeschiedenis vast te leggen; format: 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
Implementatiestrategie voor RunOnce.

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

jobs.job.container
Naam van containerresource.

jobs.job.strategy
Uitvoeringsstrategie voor deze taak.

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

jobs.template
Een set taken die is gedefinieerd in een sjabloon.

Parameters
Hiermee geeft u de runtimeparameters doorgegeven aan een pijplijn.

parameters.parameter
Parameters voor pijplijnsjablonen.

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

pool.demands
Eisen (voor een privé zwembad).

Pr
Pull-aanvraagtrigger.

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

resources.builds
Lijst met buildresources waarnaar wordt verwezen door de pijplijn.

resources.builds.build
Een buildresource 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 geen 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 pakketresources.

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

resources.pipelines
Lijst met pijplijnresources.

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.repositories
Lijst met opslagplaatsresources.

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

resources.webhooks
Lijst met webhooks.

resources.webhooks.webhook
Met 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 webhookresourcetrigger.

Planningen
De lijst met planningen bevat de geplande triggers voor de pijplijn.

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

Stadia
Fasen zijn een verzameling gerelateerde taken.

stages.stage
Een fase is een verzameling gerelateerde taken.

stages.template
U kunt een set fasen definiëren in één bestand en deze meerdere keren gebruiken in andere bestanden.

Stappen
Stappen zijn een lineaire reeks bewerkingen waaruit een taak bestaat.

steps.bash
Voert een script uit in Bash op Windows, macOS en Linux.

steps.checkout
Configureer hoe de broncode door de pijplijn wordt uitgecheckt.

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

steps.downloadBuild
Downloadt buildartefacten.

steps.getPackage
Downloadt een pakket uit een feed voor pakketbeheer in Azure Artifacts of Azure DevOps Server.

steps.powershell
Voert een script uit met behulp van Windows PowerShell (op Windows) of pwsh (Linux en macOS).

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

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

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

steps.script
Hiermee wordt een script uitgevoerd met behulp van cmd.exe in Windows en Bash op andere platforms.

steps.task
Hiermee voert u een taak uit.

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

Doel
Taken worden uitgevoerd in een uitvoeringscontext, die de agenthost of een container is.

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
Verwijs naar variabelen uit een variabelengroep.

variables.name
Definieer variabelen met behulp van 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 voor het uitvoeren van stappen voor het implementeren van uw toepassing.

includeExcludeFilters
Lijsten met items die moeten worden opgenomen of uitgesloten.

includeExcludeStringFilters
Items die moeten worden opgenomen of uitgesloten.

mountReadOnly
Volumes die alleen-lezen moeten worden gekoppeld, is de standaardwaarde allemaal 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 het gedefinieerde 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 verwerken.

Werkruimte
Werkruimteopties op de agent.

Documentatieconventies voor YAML-schema

De YAML-schemareferentie is een gedetailleerde naslaghandleiding 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 : bevindt zich een letterlijk trefwoord dat wordt gebruikt in pijplijndefinities.
• Rechts van : bevindt zich een gegevenstype. Het gegevenstype kan een primitief type zijn, zoals een tekenreeks , of een verwijzing naar een uitgebreide structuur die elders in deze verwijzing is gedefinieerd.
• Het notatiegegevenstype][ geeft een matrix van het genoemde definitietype aan. is bijvoorbeeld [ string ] een matrix van tekenreeksen.
• Het gegevenstype notatiegegevenstype:}{ duidt op een toewijzing van het ene gegevenstype aan het andere. Is bijvoorbeeld { string: string } een toewijzing van tekenreeksen aan tekenreeksen.
• Het symbool | geeft aan dat er meerdere gegevenstypen beschikbaar zijn voor het trefwoord. Betekent bijvoorbeeld job | template dat een taakdefinitie of een sjabloonreferentie is toegestaan.

Zie ook

Deze naslaginformatie heeft betrekking op het schema van een YAML-bestand van Azure Pipelines. Zie Yaml leren in Y minuten voor meer informatie over de basisbeginselen 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 is Azure Pipelines ook afhankelijk van het zien stagevan , job, taskof een taaksnelkoppeling zoals script de eerste sleutel in een toewijzing.