définition pipeline.parameters.parameter

Un paramètre représente une valeur passée à un pipeline.

parameters:
- name: string # Required as first property.
  displayName: string # Human-readable name for the parameter.
  type: string
  default: string | parameters | [ parameters ]
  values: [ string ]

Définitions qui font référence à cette définition : paramètres

Propriétés

name String. Obligatoire comme première propriété.

displayName String.
Nom lisible par l’homme pour le paramètre.

type String.
Consultez types.

default Paramètres.

values string list.

Remarques

Les champs de type et de nom sont requis lors de la définition des paramètres. Consultez tous les types de données de paramètre.

parameters:
- name: string          # name of the parameter; required
  type: enum            # see the enum data types in the following section
  default: any          # default value; if no default, then the parameter MUST be given by the user at runtime
  values: [ string ]    # allowed list of values (for some data types)

Types

La type valeur doit être l’un des enum membres du tableau suivant.

Type de données	Notes
string	string
number	peut être limité à values:, sinon toute chaîne de type nombre est acceptée
boolean	true ou false
object	toute structure YAML
step	une seule étape
stepList	Séquence d’étapes
job	un seul travail
jobList	Séquence de travaux
deployment	un seul travail de déploiement
deploymentList	séquence de travaux de déploiement
stage	une seule phase
stageList	séquence d’index

Les types de données step, stepList, job, jobList, deploymentList, stagelist et stageList utilisent tous le format de schéma YAML standard. Cet exemple inclut string, number, boolean, object, step et stepList.

parameters:
- name: myString
  type: string
  default: a string
- name: myMultiString
  type: string
  default: default
  values:
  - default
  - ubuntu
- name: myNumber
  type: number
  default: 2
  values:
  - 1
  - 2
  - 4
  - 8
  - 16
- name: myBoolean
  type: boolean
  default: true
- name: myObject
  type: object
  default:
    foo: FOO
    bar: BAR
    things:
    - one
    - two
    - three
    nested:
      one: apple
      two: pear
      count: 3
- name: myStep
  type: step
  default:
    script: echo my step
- name: mySteplist
  type: stepList
  default:
    - script: echo step one
    - script: echo step two

trigger: none

jobs: 
- job: stepList
  steps: ${{ parameters.mySteplist }}
- job: myStep
  steps:
    - ${{ parameters.myStep }}

Exemples

# File: azure-pipelines.yml
parameters:
- name: image
  displayName: Pool Image
  type: string
  default: ubuntu-latest
  values:
  - windows-latest
  - ubuntu-latest
  - macOS-latest

trigger: none

jobs:
- job: build
  displayName: build
  pool: 
    vmImage: ${{ parameters.image }}
  steps:
  - script: echo The image parameter is ${{ parameters.image }}```

Vous pouvez utiliser des paramètres pour étendre un modèle. Dans cet exemple, le pipeline utilisant le modèle fournit les valeurs à remplir dans le modèle.

# File: simple-param.yml
parameters:
- name: yesNo # name of the parameter; required
  type: boolean # data type of the parameter; required
  default: false

steps:
- script: echo ${{ parameters.yesNo }}

# File: azure-pipelines.yml
trigger:
- main

extends:
    template: simple-param.yml
    parameters:
        yesNo: false # set to a non-boolean value to have the build fail

Voir aussi

Pour plus d’informations sur l’utilisation des modèles, consultez Modèles.