Utiliser des variables dans les pipelines de mise en production classique

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

L'emploi de variables dans les pipelines de mise en production classique constitue un moyen pratique d’échanger et de transporter des données dans votre pipeline. Chaque variable est stockée en tant que chaîne et sa valeur peut changer d'une exécution de pipeline à l'autre.

Lorsque vous configurez des tâches destinées au déploiement de votre application à chaque phase de votre pipeline de mise en production classique, les variables sont capables de vous aider de la manière suivante :

• Pour simplifier la personnalisation : définissez une fois un pipeline de déploiement générique, puis adaptez-le facilement aux différentes phases. Par exemple, utilisez une variable représentant une chaîne de connexion pour le déploiement web, et ajustez-en la valeur selon les besoins de chaque phase. C'est ce que l'on appelle des variables personnalisées.

• Pour tirer parti des informations contextuelles : accédez aux détails du contexte de mise en production, comme une phase, un artefact ou l’agent qui exécute le déploiement. Par exemple, vos scripts peuvent avoir besoin de l’emplacement de la build pour son téléchargement, ou du répertoire de travail de l’agent pour créer des fichiers temporaires. C'est ce que l'on appelle des variables par défaut.

Les variables par défaut

Les variables par défaut fournissent des informations essentielles sur le contexte d’exécution de vos tâches et scripts en cours d’exécution. Ces variables vous permettent d’accéder aux détails concernant le système, la mise en production, la phase ou l’agent correspondant à l'exécution en cours.

À l’exception de System.Debug, les variables par défaut sont en lecture seule, leurs valeurs étant définies automatiquement par le système.

Certaines des principales variables sont décrites dans les tableaux ci-dessous. Pour afficher la liste complète, consultez Afficher les valeurs actuelles de toutes les variables.

Variables système

Variables de mise en production

Variables de la phase de mise en production

Variables de l’agent

Variables des artefacts de mise en production

Pour chaque artefact référencé dans une mise en production, vous pouvez utiliser les variables d’artefact suivantes. Notez que toutes les variables ne s’appliquent pas à chaque type d’artefact. Le tableau ci-dessous répertorie les variables d’artefact par défaut et fournit des exemples de leurs valeurs en fonction du type d’artefact. Un exemple vide indique que la variable n’est pas applicable à ce type d’artefact.

Remplacez l’espace réservé {alias} par la valeur que vous avez spécifiée pour l’alias de la source d’artefact ou par la valeur par défaut générée pour le pipeline de mise en production.

Variables de l’artefact principal

Dans les pipelines de mise en production classiques, si vous utilisez plusieurs artefacts, vous pouvez en désigner en tant qu'artefact principal. Azure Pipelines remplit alors les variables suivantes pour l’artefact principal désigné.

Utiliser les variables par défaut

Vous pouvez utiliser les variables par défaut de deux manières : en tant que paramètres pour des tâches dans un pipeline de mise en production ou dans vos scripts.

Vous pouvez utiliser une variable par défaut directement en tant qu’entrée dans une tâche. Par exemple, pour transmettre Release.Artifacts.{Artifact alias}.DefinitionName en tant qu’argument à une tâche PowerShell pour un artefact dont l'alias est ASPNET4.CI, vous devez utiliser $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Pour utiliser une variable par défaut dans votre script, vous devez d’abord remplacer . par _ dans les noms des variables par défaut. Par exemple, pour imprimer la valeur d’un Release.Artifacts.{Artifact alias}.DefinitionName artefact avec ASPNET4.CI comme alias dans un script PowerShell, utilisez $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. Notez que l’alias d’origine, ASPNET4.CI, est remplacé par ASPNET4_CI.

Variables personnalisées

Les variables personnalisées peuvent être définies dans différentes étendues.

• Groupes de variables : utilisez-les pour partager des valeurs entre toutes les définitions d’un projet. Cela est utile lorsque vous souhaitez utiliser les mêmes valeurs sur l'ensemble des définitions, phases et tâches d’un projet, et pouvoir les gérer à partir d’un emplacement unique. Les groupes de variables sont définis et gérés dans Pipelines>Bibliothèque.

• Variables de pipeline de mise en production : utilisez-les pour partager des valeurs entre toutes les phases d’un pipeline de mise en production. Elles sont particulièrement utiles dans les scénarios où vous avez besoin d’une valeur cohérente entre les différentes phases et tâches, avec la possibilité de la mettre à jour à partir d’un emplacement unique. Ces variables sont définies et gérées sous l’onglet Variables du pipeline de mise en production. Dans la page Variables de pipeline, ouvrez la liste déroulante Étendue et sélectionnez Mise en production lors de l’ajout d’une variable.

• Variables de phase : utilisez-les pour partager des valeurs dans une phase spécifique d’un pipeline de mise en production. Cela est utile pour des valeurs qui diffèrent d’une phase à l’autre, mais qui restent les mêmes dans toutes les tâches d’une phase. Ces variables sont définies et gérées sous l’onglet Variables du pipeline de mise en production. Dans la page Variables de pipeline, ouvrez la liste déroulante Étendue et sélectionnez l'environnement approprié lors de l’ajout d’une variable.

L’utilisation de variables personnalisées au niveau du projet, du pipeline de mise en production et de la phase vous offre les possibilités suivantes :

• Éviter de dupliquer des valeurs, afin de faciliter la mise à jour de l’ensemble des occurrences en un seul changement.

• Sécuriser des valeurs sensibles en les empêchant d’être consultées ou modifiées par des utilisateurs. Pour marquer une variable comme sécurisée (secrète), sélectionnez l’icône située face à elle.

  Important

  Les valeurs des variables masquées (secrètes) sont stockées en toute sécurité sur le serveur et ne peuvent pas être consultées par les utilisateurs après l’enregistrement. Lors du déploiement, Azure Pipelines déchiffre ces valeurs qui sont référencées par des tâches et les transmet à l’agent via un canal HTTPS sécurisé.

Utiliser des variables personnalisées

Pour utiliser des variables personnalisées dans vos tâches, placez le nom de la variable entre parenthèses et de le faire précéder d’un caractère $. Par exemple, pour une variable nommée adminUserName, vous pouvez insérer sa valeur actuelle dans une tâche en tant que $(adminUserName).

Définir et modifier vos variables dans un script

Pour définir ou modifier une variable à partir d’un script, utilisez la commande de journalisation task.setvariable. La valeur de la variable mise à jour est limitée au travail en cours d’exécution et ne persiste pas dans les différents travaux ou phases. Veuillez noter que les noms de variables sont transformés en majuscules, et les caractères « . » et «   » sont remplacés par « _ ».

Par exemple, Agent.WorkFolder devient AGENT_WORKFOLDER.

• Sous Windows, vous accédez à cet variable en tant que %AGENT_WORKFOLDER% ou $env:AGENT_WORKFOLDER.
• Sur Linux et macOS, veuillez utiliser $AGENT_WORKFOLDER.

@echo ##vso[task.setvariable variable=sauce]crushed tomatoes
@echo ##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic

"$(sauce)" "$(secret.Sauce)"

@echo off
set sauceArgument=%~1
set secretSauceArgument=%~2
@echo No problem reading %sauceArgument% or %SAUCE%
@echo But I cannot read %SECRET_SAUCE%
@echo But I can read %secretSauceArgument% (but the log is redacted so I do not spoil the secret)

Write-Host "##vso[task.setvariable variable=sauce]crushed tomatoes"
Write-Host "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with
            garlic"

-sauceArgument "$(sauce)" -secretSauceArgument "$(secret.Sauce)"

Param(
   [string]$sauceArgument,
   [string]$secretSauceArgument
)
Write-Host No problem reading $env:SAUCE or $sauceArgument
Write-Host But I cannot read $env:SECRET_SAUCE
Write-Host But I can read $secretSauceArgument "(but the log is redacted so I do not spoil the secret)"

- pwsh: |
      Write-Host No problem reading $(sauce)
      Write-Host But I cannot read $env:SECRET_SAUCE
      Write-Host But I can read $(secret.Sauce) "(but the log is redacted so I do not spoil the secret)"

#!/bin/bash
echo "##vso[task.setvariable variable=sauce]crushed tomatoes"
echo "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic"

"$(sauce)" "$(secret.Sauce)"

#!/bin/bash
echo "No problem reading $SAUCE"
echo "But I cannot read $SECRET_SAUCE"

Sortie de console après lecture des variables :

No problem reading crushed tomatoes or crushed tomatoes
But I cannot read 
But I can read ******** (but the log is redacted so I do not spoil the secret)

Afficher les valeurs actuelles de l’ensemble des variables

1. Sélectionnez Pipelines>Mises en production, puis sélectionnez votre pipeline de mise en production.

2. Ouvrez la vue récapitulative de votre mise en production et sélectionnez la phase qui vous intéresse. Dans la liste des étapes, choisissez Initialiser le travail.

   

3. Cette opération ouvre les journaux de cette phase. Faites défiler vers le bas pour afficher les valeurs utilisées par l’agent pour ce travail.

   

Exécuter une mise en production en mode débogage

L’exécution d’une mise en production en mode débogage peut vous aider à diagnostiquer et résoudre des problèmes ou des défaillances en vous montrant des informations supplémentaires pendant l’exécution de la mise en production. Vous pouvez activer le mode débogage pour l’intégralité de la mise en production ou bien uniquement pour les tâches d'une phase de mise en production spécifique.

• Pour activer le mode débogage pour une mise en production entière, ajoutez une variable nommée System.Debug définie sur la valeur true sous l’onglet Variables du pipeline de mise en production.

• Pour activer le mode débogage sur une phase spécifique, ouvrez la boîte de dialogue Configurer la phase dans le menu contextuel de la phase et ajoutez une variable nommée System.Debug définie sur la valeur true à l’onglet Variables.

• Vous pouvez également créer un groupe de variables contenant une variable nommée System.Debug définie sur la valeur true et lier ce groupe de variables au pipeline de mise en production.

Contenu connexe

• Sources d'artefacts dans les pipelines de diffusion classiques

• Déployer des artefacts de demande de tirage (pull request)

• Utiliser des variables dans un groupe de variables