Mallparametrar

Du kan ange parametrar och deras datatyper i en mall och referera till dessa parametrar i en pipeline. Med templateContext kan du också skicka egenskaper till steg, steg och jobb som används som parametrar i en mall.

Du kan också använda parametrar utanför mallar. Du kan bara använda literaler för parameterstandardvärden. Läs mer om parametrar i YAML-schemat.

Skicka parametrar

Parametrarna måste innehålla ett namn och en datatyp. I azure-pipelines.yml, när parametern yesNo är inställd på ett booleskt värde, lyckas bygget. När yesNo är inställt på en sträng som applesmisslyckas bygget.

# 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

Använda templateContext för att skicka egenskaper till mallar

Du kan använda templateContext för att skicka fler egenskaper till steg, steg och jobb som används som parametrar i en mall. Mer specifikt kan du ange templateContext datatypen jobList, deploymentListeller stageList parametern .

Du kan använda templateContext för att göra det enklare att konfigurera miljöer när du bearbetar varje jobb. Genom att kombinera ett jobb och dess miljöegenskaper templateContext kan du få mer underhållsbara och enklare att förstå YAML.

I det här exemplet har parametern testSet i testing-template.yml datatypen jobList. Mallen testing-template.yml skapar en ny variabel testJob med hjälp av varje nyckelord. Mallen refererar sedan till testJob.templateContext.expectedHTTPResponseCode, som anges i azure-pipeline.yml och skickas till mallen.

När svarskoden är 200 gör mallen en REST-begäran. När svarskoden är 500 matar mallen ut alla miljövariabler för felsökning.

templateContext kan innehålla egenskaper.

#testing-template.yml

parameters: 
- name: testSet
  type: jobList

jobs:
- ${{ each testJob in parameters.testSet }}:
  - ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 200) }}:
    - job:
      steps: 
      - powershell: 'Invoke-RestMethod -Uri https://blogs.msdn.microsoft.com/powershell/feed/ | Format-Table -Property Title, pubDate'
      - ${{ testJob.steps }}    
  - ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 500) }}:
    - job:
      steps:
      - powershell: 'Get-ChildItem -Path Env:\'
      - ${{ testJob.steps }}

#azure-pipeline.yml

trigger: none

pool:
  vmImage: ubuntu-latest

extends:
  template: testing-template.yml
  parameters:
    testSet:
    - job: positive_test
      templateContext:
        expectedHTTPResponseCode: 200
      steps:
      - script: echo "Run positive test" 
    - job: negative_test
      templateContext:
        expectedHTTPResponseCode: 500
      steps:
      - script: echo "Run negative test" 

Parametrar för att välja en mall vid körning

Du kan anropa olika mallar från en YAML-pipeline beroende på ett villkor. I det här exemplet experimental.yml körs YAML när parametern experimentalTemplate är sann.

#azure-pipeline.yml
parameters:
- name: experimentalTemplate
  displayName: 'Use experimental build process?'
  type: boolean
  default: false

steps:
- ${{ if eq(parameters.experimentalTemplate, true) }}:
  - template: experimental.yml
- ${{ if not(eq(parameters.experimentalTemplate, true)) }}:
  - template: stable.yml

Parameterdatatyper

Datatyp	Kommentar
string	sträng
number	kan begränsas till values:, annars accepteras en talliknande sträng
boolean	true eller false
object	någon YAML-struktur
step	ett enda steg
stepList	sekvens med steg
job	ett enda jobb
jobList	sekvens med jobb
deployment	ett enda distributionsjobb
deploymentList	sekvens med distributionsjobb
stage	en enda fas
stageList	sekvens av faser

Datatyperna step, stepList, job, jobList, deployment, deploymentList, stage och stageList använder alla yaml-standardschemaformat. I det här exemplet ingår sträng, tal, booleskt värde, objekt, steg och 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 }}

Du kan iterera genom ett objekt och skriva ut varje sträng i objektet.

parameters:
- name: listOfStrings
  type: object
  default:
  - one
  - two

steps:
- ${{ each value in parameters.listOfStrings }}:
  - script: echo ${{ value }}

Dessutom kan du iterera genom kapslade element i ett objekt.

parameters:
- name: listOfFruits
  type: object
  default:
  - fruitName: 'apple'
    colors: ['red','green']
  - fruitName: 'lemon'
    colors: ['yellow']

steps:
- ${{ each fruit in parameters.listOfFruits }} :
  - ${{ each fruitColor in fruit.colors}} :
    - script: echo ${{ fruit.fruitName}} ${{ fruitColor }}

Obligatoriska parametrar

Du kan lägga till ett valideringssteg i början av mallen för att söka efter de parametrar du behöver.

Här är ett exempel som söker efter parametern solution med hjälp av Bash (som gör att den kan fungera på valfri plattform):

# File: steps/msbuild.yml

parameters:
- name: 'solution'
  default: ''
  type: string

steps:
- bash: |
    if [ -z "$SOLUTION" ]; then
      echo "##vso[task.logissue type=error;]Missing template parameter \"solution\""
      echo "##vso[task.complete result=Failed;]"
    fi
  env:
    SOLUTION: ${{ parameters.solution }}
  displayName: Check for required parameters
- task: msbuild@1
  inputs:
    solution: ${{ parameters.solution }}
- task: vstest@2
  inputs:
    solution: ${{ parameters.solution }}

Så här visar du att mallen misslyckas om den saknar den obligatoriska parametern:

# File: azure-pipelines.yml

# This will fail since it doesn't set the "solution" parameter to anything,
# so the template will use its default of an empty string
steps:
- template: steps/msbuild.yml