Informations de référence sur le schéma YAML pour Azure Pipelines

  • Article

La référence de schéma YAML pour Azure Pipelines est une référence détaillée pour les pipelines YAML qui répertorie toutes les syntaxes YAML prises en charge et leurs options disponibles.

Pour créer un pipeline YAML, commencez par la définition du pipeline . Pour plus d’informations sur la création de pipelines YAML, consultez Personnaliser votre pipeline.

La référence de schéma YAML ne couvre pas les tâches. Pour plus d’informations sur les tâches, consultez l’index des tâches Azure Pipelines.

Définitions

Pipeline
Un pipeline est une ou plusieurs étapes qui décrivent un processus CI/CD. La définition du pipeline contient la documentation relative aux propriétés de niveau racine telles que name.

Pipeline
Un pipeline est un ou plusieurs travaux qui décrivent un processus CI/CD.

S' étend
Étend un pipeline à l’aide d’un modèle.

Emplois
Spécifie les travaux qui composent le travail d’une étape.

Emplois
Spécifie les travaux qui composent le travail d’un pipeline.

jobs.deployment
Un travail de déploiement est un type spécial de travail. Il s’agit d’une collection d’étapes à exécuter séquentiellement sur l’environnement.

jobs.deployment.environment
Nom de l’environnement cible et éventuellement nom de ressource pour enregistrer l’historique du déploiement ; format : nom-environnement.resource-name.

jobs.deployment.strategy
Stratégie d’exécution pour ce déploiement.

jobs.deployment.strategy.canary
Stratégie de déploiement Canary.

jobs.deployment.strategy.rolling
Stratégie de déploiement continu.

jobs.deployment.strategy.runOnce
Stratégie de déploiement RunOnce.

jobs.job
Un travail est une collection d’étapes exécutées par un agent ou sur un serveur.

jobs.job.container
Nom de la ressource de conteneur.

jobs.job.strategy
Stratégie d’exécution pour ce travail.

jobs.job.uses
Toutes les ressources requises par ce travail qui ne sont pas déjà référencées.

jobs.template
Ensemble de travaux définis dans un modèle.

Paramètres
Spécifie les paramètres d’exécution passés à un pipeline.

parameters.parameter
Paramètres du modèle de pipeline.

Piscine
Pool à utiliser pour un travail du pipeline.

pool.demandes
Demandes (pour un pool privé).

Pr
Déclencheur de demande de tirage.

Ressources
Resources spécifie les builds, référentiels, pipelines et autres ressources utilisées par le pipeline.

resources.builds
Liste des ressources de build référencées par le pipeline.

resources.builds.build
Ressource de build utilisée pour référencer des artefacts d’une exécution.

resources.containers
Liste des images conteneur.

resources.containers.container
Ressource de conteneur utilisée pour référencer une image conteneur.

resources.containers.container.trigger
Spécifiez aucun à désactiver, true à déclencher sur toutes les balises d’image ou utilisez la syntaxe complète comme décrit dans les exemples suivants.

resources.packages
Liste des ressources de package.

resources.packages.package
Ressource de package utilisée pour référencer un package GitHub NuGet ou npm.

resources.pipelines
Liste des ressources de pipeline.

resources.pipelines.pipelines.pipeline
Une ressource de pipeline.

resources.pipelines.pipeline.trigger
Spécifiez aucun pour désactiver, true pour inclure toutes les branches ou utilisez la syntaxe complète comme décrit dans les exemples suivants.

resources.pipelines.pipeline.trigger.branches
Branches à inclure ou à exclure pour déclencher une exécution.

resources.repositories
Liste des ressources du référentiel.

resources.repositories.repository
Une ressource de référentiel est utilisée pour référencer un référentiel supplémentaire dans votre pipeline.

resources.webhooks
Liste des webhooks.

resources.webhooks.webhook
Une ressource webhook vous permet d’intégrer votre pipeline à un service externe pour automatiser le workflow.

resources.webhooks.webhook.filters
Liste des filtres de déclencheur.

resources.webhooks.webhook.filters.filter
Filtre de déclencheur de ressources webhook.

Horaires
La liste des planifications spécifie les déclencheurs planifiés pour le pipeline.

schedules.cron
Un déclencheur planifié spécifie une planification sur laquelle les branches sont créées.

Étapes
Les phases sont une collection de travaux associés.

stages.stage
Une étape est une collection de travaux associés.

stages.template
Vous pouvez définir un ensemble d’étapes dans un fichier et l’utiliser plusieurs fois dans d’autres fichiers.

Étapes
Les étapes sont une séquence linéaire d’opérations qui composent un travail.

steps.bash
Exécute un script dans Bash sur Windows, macOS et Linux.

steps.checkout
Configurez la façon dont le pipeline extrait le code source.

steps.download
Télécharge les artefacts associés à l’exécution actuelle ou à partir d’un autre pipeline Azure associé en tant que ressource de pipeline.

steps.downloadBuild
Télécharge les artefacts de build.

steps.getPackage
Télécharge un package à partir d’un flux de gestion de package dans Azure Artifacts ou Azure DevOps Server.

steps.powershell
Exécute un script à l’aide de Windows PowerShell (sur Windows) ou pwsh (Linux et macOS).

steps.publish
Publie (charge) un fichier ou un dossier en tant qu’artefact de pipeline que d’autres travaux et pipelines peuvent consommer.

steps.pwsh
Exécute un script dans PowerShell Core sur Windows, macOS et Linux.

steps.reviewApp
Les téléchargements créent dynamiquement une ressource sous un fournisseur de phases de déploiement.

steps.script
Exécute un script en utilisant cmd.exe sur Windows et Bash sur d’autres plateformes.

steps.task
Exécute une tâche.

steps.template
Définissez un ensemble d’étapes dans un fichier et utilisez-le plusieurs fois dans un autre fichier.

Cible
Les tâches s’exécutent dans un contexte d’exécution, qui est l’hôte de l’agent ou un conteneur.

target.settableVariables
Restrictions sur les variables qui peuvent être définies.

Déclencheur
Déclencheur d’intégration continue (push).

Variables
Définissez des variables à l’aide de paires nom/valeur.

variables.group
Référencez des variables à partir d’un groupe de variables.

variables.name
Définissez des variables à l’aide du nom et de la syntaxe complète.

variables.template
Définir des variables dans un modèle.

Définitions de prise en charge

Notes

Les définitions de prise en charge ne sont pas destinées à être utilisées directement dans un pipeline. Les définitions de prise en charge sont utilisées uniquement dans le cadre d’autres définitions et sont incluses ici pour référence.

deployHook
Permet d’exécuter les étapes qui déploient votre application.

includeExcludeFilters
Listes d’éléments à inclure ou à exclure.

includeExcludeStringFilters
Éléments à inclure ou à exclure.

mountReadOnly
Volumes à monter en lecture seule, la valeur par défaut est toutes false.

onFailureHook
Permet d’exécuter des étapes pour les actions de restauration ou propre.

onSuccessHook
Permet d’exécuter des étapes pour les actions de restauration ou propre.

onSuccessOrFailureHook
Permet d’exécuter des étapes pour les actions de restauration ou propre.

postRouteTrafficHook
Permet d’exécuter les étapes après le routage du trafic. En règle générale, ces tâches supervisent l’intégrité de la version mise à jour pendant une période définie.

preDeployHook
Permet d’exécuter des étapes qui initialisent des ressources avant le démarrage du déploiement de l’application.

routeTrafficHook
Permet d’exécuter des étapes qui servent le trafic vers la version mise à jour.

Espace
Options de l’espace de travail sur l’agent.

Conventions de documentation sur les schémas YAML

La référence de schéma YAML est un guide de référence détaillé sur les pipelines YAML Azure Pipelines. Il inclut un catalogue de toutes les fonctionnalités YAML prises en charge et des options disponibles.

Voici les conventions de syntaxe utilisées dans la référence de schéma YAML.

  • À gauche de se trouve un littéral mot clé utilisé dans les définitions de : pipeline.
  • À droite de : figure un type de données. Le type de données peut être un type primitif comme une chaîne ou une référence à une structure riche définie ailleurs dans cette référence.
  • Le type de] données de notation [ indique un tableau du type de définition mentionné. Par instance, [ string ] est un tableau de chaînes.
  • La notation {type_de_données:type_de_données} indique un mappage entre deux types de données. Par instance, { string: string } est un mappage de chaînes à chaînes.
  • Le symbole | indique que plusieurs types de données sont disponibles pour le mot clé. Par instance, job | template signifie qu’une définition de travail ou une référence de modèle est autorisée.

Voir aussi

Cette référence couvre le schéma d’un fichier YAML Azure Pipelines. Pour en savoir plus sur les principes de base de YAML, consultez Learn YAML in Y Minutes. Azure Pipelines ne prend pas en charge toutes les fonctionnalités YAML. Les fonctionnalités non prises en charge incluent des ancres, des clés complexes et des ensembles. En outre, contrairement à YAML standard, Azure Pipelines dépend de l’affichage stagede , job, taskou d’un raccourci de tâche comme script la première clé d’un mappage.