Utiliser des variables dans les pipelines de mise en production classique

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

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 sous forme de chaîne et sa valeur peut changer entre les exécutions du pipeline.

Lorsque vous configurez des tâches pour déployer votre application à chaque étape de votre pipeline de mise en production Classique, les variables peuvent vous aider à :

• 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. Ces variables sont appelées 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. Ces variables sont appelées 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 donnent accès à des détails sur le système, la version, l’étape ou l’agent dans lequel ils s’exécutent.

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

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 version

Variables de la phase de mise en production

Variables de l’agent

Variables d’artéfacts de release

Pour chaque artefact que vous référencez dans une version, utilisez les variables d’artefact suivantes. Notez que toutes les variables ne s’appliquent pas à chaque type d’artefact. Le tableau suivant répertorie les variables d’artefact par défaut et fournit des exemples de leurs valeurs en fonction du type d’artefact. Si un exemple est vide, il indique que la variable n’est pas applicable à ce type d’artefact.

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

Variables d’artefact principales

Dans les pipelines de mise en production classiques, si vous utilisez plusieurs artefacts, vous pouvez désigner un artefact comme artefact principal. Azure Pipelines remplit ensuite 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.

Utilisez une variable par défaut directement comme entrée pour une tâche. Par exemple, pour passer Release.Artifacts.{Artifact alias}.DefinitionName en tant qu’argument à une tâche PowerShell pour un artefact avec ASPNET4.CI comme alias, utilisez $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Pour utiliser une variable par défaut dans votre script, remplacez le . dans les noms de variables par défaut par _. 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. L’alias d’origine, ASPNET4.CI, est remplacé par ASPNET4_CI.

Variables personnalisées

Vous pouvez définir des variables personnalisées à différentes étendues.

• Groupes de variables : utilisez-les pour partager des valeurs entre toutes les définitions d’un projet. Cette approche est utile lorsque vous souhaitez utiliser les mêmes valeurs dans les définitions, les étapes et les tâches au sein d’un projet, et 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. Cette approche est idéale pour les scénarios où vous avez besoin d’une valeur cohérente entre les étapes et les 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. Cette approche est utile pour les valeurs qui diffèrent d’une étape à l’autre, mais qui sont cohérentes 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.

En utilisant des variables personnalisées au niveau du projet, du pipeline de mise en production et des niveaux intermédiaires, vous pouvez :

• É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 (secret), sélectionnez l’icône en regard de la variable.

  Important

  Les valeurs des variables masquées (secret) sont stockées en toute sécurité sur le serveur et les utilisateurs ne peuvent pas les afficher après leur enregistrement. Pendant le déploiement, Azure Pipelines déchiffre ces valeurs quand les tâches les référencent 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, si vous avez une variable nommée adminUserName, insérez 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, accédez à cette variable sous la forme %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 étape ouvre les logs. Faites défiler vers le bas pour afficher les valeurs que l’agent utilise pour ce travail.

   

Exécuter une version en mode débogage

L’exécution d’une version en mode débogage peut vous aider à diagnostiquer et résoudre les problèmes en affichant des informations supplémentaires pendant l’exécution de la mise en production. Vous pouvez activer le mode débogage pour l’ensemble de la version ou simplement pour les tâches dans une phase de mise en production spécifique.

• Pour activer le mode débogage pour l’ensemble de la version, ajoutez une variable nommée System.Debug avec la valeur true à l’onglet Variables du pipeline de mise en production.

• Pour activer le mode débogage d’une étape spécifique, ouvrez la boîte de dialogue Configurer l’étape à partir du menu contextuel de l’étape et ajoutez une variable nommée System.Debug avec 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.

Utiliser l’IA pour concevoir, valider et résoudre les problèmes des variables de mise en production

Les exemples d’invites suivants pour Copilot Chat vous aident à comprendre la portée des variables et leur ordre de priorité, à concevoir une stratégie de gestion des variables facile à maintenir, à valider l’utilisation actuelle et, si nécessaire, à résoudre les problèmes de résolution des variables. Copiez et collez ces instructions dans Copilot Chat, et remplacez les espaces réservés par vos noms d’étape, de tâche et de variable.

Copilot est alimenté par l’IA, donc les surprises et les erreurs sont possibles. Pour plus d’informations, consultez les FAQ sur l’utilisation générale de Copilot.

Contenu connexe

• Sources d'artefacts dans les pipelines de diffusion classiques

• Déployer les artefacts d’une pull request

• Utiliser des variables dans un groupe de variables