Partager via

définition de pipeline.parameters.parameter

Un paramètre représente une valeur passée à un pipeline. Les paramètres doivent inclure une valeur par défaut.

parameters:
- name: string # Required as first property.
  displayName: string # Human-readable name for the parameter.
  type: string
  default: string | parameters | [ parameters ] # 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).

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

chaîne name. Obligatoire en tant que première propriété.

chaîne displayName.
nom lisible par l’homme pour le paramètre.

chaîne type.
Voir types.

default paramètres.
Valeur par défaut; s’il n’y a pas de valeur par défaut, alors le paramètre DOIT être donné par l’utilisateur au moment de l’exécution.

values liste de chaînes.
Liste de valeurs autorisées (pour certains types de données).

Remarques

Les champs et type les name champs sont obligatoires lors de la définition des paramètres. En savoir plus sur 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)

Les types

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

Type de données Remarques
string corde
number peut être limité à values:, sinon toute chaîne de type nombre est acceptée
boolean true ou false
object n’importe quelle 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 étape
stageList séquence d’étapes

L’étape, stepList, job, jobList, deploymentList, stage et stageList, tous utilisent le format de schéma YAML standard. Cet exemple inclut la chaîne, le nombre, la valeur booléenne, l’objet, l’étape 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 }}

Utilisez 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 param; required
  type: boolean # data type of param; required
  default: false

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

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

extends:
    template: simple-param.yml
    parameters:
        yesNo: false

Utilisez des modèles pour définir des paramètres, puis passez ces paramètres à un pipeline.

# File: template.yml 
parameters:
  - name: environment
    type: string
    default: 'production'

jobs:
- job: Deploy
  displayName: 'Deploy to ${{ parameters.environment }}'
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - script: echo "Deploying to ${{ parameters.environment }}"
    displayName: 'Deploy Step'

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

pool:
  vmImage: 'ubuntu-latest'

jobs:
- template: template.yml
  parameters:
    environment: 'staging'

Voir aussi

Consultez les modèles pour en savoir plus sur l’utilisation des modèles.

  • Last updated on