Vérifier les types de paramètres et de variables

  • 4 minutes

Les paramètres et les variables sont des composants essentiels pour personnaliser le comportement du pipeline. Celles-ci permettent de transmettre des valeurs d’exécution à des tâches et des scripts de pipeline et de définir des variables à utiliser dans différentes phases de pipeline. Lorsque vous utilisez des paramètres et des variables dans des pipelines, il est essentiel de définir correctement leurs types de données pour éviter tout comportement inattendu susceptible d’affecter la sécurité ou l’exécution du pipeline du projet.

Types de paramètres et de variables

Les paramètres et les variables sont essentiels à la personnalisation du pipeline, car ils permettent une flexibilité et permettent aux scripts de pipeline d’être plus dynamiques. Vous pouvez les utiliser pour stocker des valeurs telles que des chaînes de connexion, des variables d’environnement et d’autres données sensibles. La définition correcte de leurs types de données est également essentielle pour éviter les erreurs inattendues ou les vulnérabilités résultant d’une utilisation incorrecte.

Ajouter un paramètre ou une variable à votre pipeline

parameters:
- name: myParameterName
  type: myDataType
  default: myDefaultValue

variables:
- name: myReadOnlyVar
  value: myValue
  readonly: true

Remplacez myParameterName, , myDataTypemyDefaultValue, myReadOnlyVaret myValue par vos valeurs souhaitées.

Exemple:

parameters:
- name: image
  displayName: Pool Image
  type: string
  default: ubuntu-latest
  values:
  - windows-latest
  - ubuntu-latest
  - macOS-latest

variables:
 - name: eShopOnWeb
   value: myValue

Utilisez les types de données corrects lors de la définition de vos paramètres

Azure Pipelines prend en charge les types de données suivants :

  • ficelle
  • booléen
  • nombre
  • objet
  • étape

Contrairement aux variables, les paramètres de pipeline ne peuvent pas être modifiés par un pipeline pendant son exécution. Les paramètres ont des types de données tels que number et string, et ils peuvent être limités à un sous-ensemble de valeurs. La restriction des paramètres est utile lorsqu’une partie configurable par l’utilisateur du pipeline doit prendre une valeur uniquement à partir d’une liste contrainte. La configuration garantit que le pipeline ne prendra pas de données arbitraires.

Définir des secrets en tant que variables secrètes ou dans le cadre d’un groupe de variables

Vous pouvez utiliser Azure Key Vault pour stocker les secrets, puis les référencer dans votre script de pipeline.

Exemple:

variables:
 - name: eShopOnWeb
   value: myValue

# You can define variable groups to reuse variables across pipelines
# and to manage sensitive data centrally.

variables:
- group: eShopOnWeb
- name: ConnectionStrings.CatalogConnection
  value: '$(CatalogConnectionToken)'

Utilisez la readonly propriété pour vous assurer que les variables ne sont pas modifiées par un pipeline pendant son exécution

Il est utile de s’assurer qu’une variable n’est pas modifiée par un pipeline pendant son exécution. Par exemple, vous pouvez utiliser cette propriété pour vous assurer qu’une variable n’est pas modifiée par un pipeline pendant son exécution.

Exemple:

variables:
- name: eShopOnWeb
  value: myValue
  readonly: true

Défiez-vous-même

Un excellent moyen de s’assurer que les types de paramètres et de variables consiste à créer un pipeline qui utilise des paramètres et des variables. Définissez vos paramètres et variables à l’aide de la syntaxe correcte et du langage de type sécurisé. Ensuite, utilisez la validation des paramètres pour vous assurer que le pipeline s’exécute correctement. Enfin, utilisez des groupes de variables sécurisés pour protéger les informations sensibles. Testez votre pipeline pour vous assurer qu’il fonctionne comme prévu et utilisez les journaux de pipeline pour résoudre les problèmes.

Essayez également de créer un pipeline YAML qui inclut un paramètre avec un type incorrect et l’exécutez. Ensuite, corrigez l’erreur en déclarant le type correct pour le paramètre et réexécutez le pipeline. Il vous aide à comprendre l’importance de conserver le type de paramètres et de variables dans le code du pipeline.

Pour plus d’informations sur les variables et les paramètres, consultez :