Partager via

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 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 au niveau racine, comme name.

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

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

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 un nom de ressource pour enregistrer l’historique du déploiement ; format : environment-name.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 propagé .

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 ressource conteneur.

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

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

jobs.template
Un 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 de modèle de pipeline.

pool
Quel pool utiliser pour un travail du pipeline.

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

pr
déclencheur de demande d’extraction.

ressources
Resources spécifie des builds, des référentiels, des pipelines et d’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 à partir d’une exécution.

resources.containers
Liste d’images conteneur.

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

resources.containers.container.trigger
Spécifier aucun pour désactiver, true pour déclencher sur toutes les balises d’image ou utiliser 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 NuGet ou npm GitHub.

resources.pipelines
Liste des ressources de pipeline.

resources.pipelines.pipeline
ressource de pipeline.

resources.pipelines.pipeline.trigger
Spécifier aucun pour désactiver, true pour inclure toutes les branches ou utiliser 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.repositorys
Liste des ressources du référentiel.

resources.repository.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
ressource webhook vous permet d’intégrer votre pipeline à un service externe pour automatiser le flux de travail.

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

resources.webhooks.webhook.filters.filter
filtre de déclencheur de ressource Webhook.

planifications
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 générées.

étapes
Étapes sont une collection de travaux connexes.

stages.stage
une étape A est une collection de travaux connexes.

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

étapes
É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
Configurer 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
Téléchargements crée une ressource dynamiquement sous un fournisseur de phase de déploiement.

steps.script
Exécute un script à l’aide de cmd.exe sur Windows et Bash sur d’autres plateformes.

steps.task
Exécute une tâche.

steps.template
Définir un ensemble d’étapes dans un fichier et l’utiliser plusieurs fois dans un autre fichier.

cible
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éfinir des variables à l’aide de paires nom/valeur.

variables.group
variables de référence à partir d’un groupe de variables.

variables.name
Définir 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

Remarque

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
Utilisé pour exécuter des é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 false.

onFailureHook
Utilisé pour exécuter les étapes de restauration ou de nettoyage.

onSuccessHook
Utilisé pour exécuter les étapes de restauration ou de nettoyage.

onSuccessOrFailureHook
Utilisé pour exécuter les étapes de restauration ou de nettoyage.

postRouteTrafficHook
Utilisé pour exécuter les étapes après le routage du trafic. En règle générale, ces tâches surveillent l’intégrité de la version mise à jour pour un intervalle défini.

preDeployHook
Utilisé pour exécuter les étapes qui initialisent les ressources avant le démarrage du déploiement de l’application.

routeTrafficHook
Utilisé pour exécuter les étapes qui servent le trafic vers la version mise à jour.

de l’espace de travail
options d’espace de travail sur l’agent.

Conventions de documentation de schéma YAML

La référence de schéma YAML est un guide de référence détaillé des 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 : est un mot clé littéral utilisé dans les définitions de pipeline.
  • À droite de :, il y a un type de données. Le type de données peut être un type primitif comme chaîne ou une référence à une structure riche définie ailleurs dans cette référence.
  • La notation [type de données] indique un tableau du type de définition mentionné. Par exemple, [ string ] est un tableau de chaînes.
  • La notation {type de données:type de données} indique un mappage d’un type de données à un autre. Par exemple, { string: string } est un mappage de chaînes à des chaînes.
  • Le symbole | indique qu’il existe plusieurs types de données disponibles pour le mot clé. Par exemple, 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 découvrir 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 jeux. En outre, contrairement à YAML standard, Azure Pipelines dépend de la vue stage, job, taskou d’un raccourci de tâche comme script comme première touche d’un mappage.