Sablon paraméterei

A paramétereket és az adattípusokat megadhatja egy sablonban, és hivatkozhat ezekre a paraméterekre egy folyamatban. A templateContext használatával tulajdonságokat is átadhat a sablonban paraméterekként használt szakaszoknak, lépéseknek és feladatoknak.

A sablonon kívüli paramétereket is használhatja. A paraméter alapértelmezett értékeihez csak literálokat használhat. További információ a YAML-séma paramétereiről.

Paraméterek átadása

A paramétereknek nevet és adattípust kell tartalmazniuk. Ha azure-pipelines.ymla paraméter yesNo logikai értékre van állítva, a build sikeres lesz. Ha yesNo például egy sztringre applesvan állítva, a build meghiúsul.

# 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

Tulajdonságok átadása sablonoknak a templateContext használatával

További tulajdonságokat adhat templateContext át a sablonban paraméterekként használt szakaszoknak, lépéseknek és feladatoknak. Pontosabban megadhatja templateContext a , deploymentListvagy stageList paraméter jobListadattípusát.

Az egyes feladatok feldolgozásakor egyszerűbbé teheti templateContext a környezetek beállítását. A feladatok és a környezettulajdonságok objektumainak összekapcsolásával templateContext könnyebben megértheti a YAML-et.

Ebben a példában a paraméter testSettesting-template.yml adattípusa jobListvan. A sablon testing-template.yml minden kulcsszóval létrehoz egy új változót testJob. A sablon ezután a testJob.templateContext.expectedHTTPResponseCodebeállítva azure-pipeline.yml és a sablonnak átadott sablonra hivatkozik.

Ha a válaszkód 200, a sablon REST-kérést küld. Ha a válaszkód 500, a sablon az összes környezeti változót megjeleníti a hibakereséshez.

templateContext tulajdonságokat tartalmazhat.

#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" 

Paraméterek a sablon futásidőben való kiválasztásához

A folyamat YAML-sablonjaitól különböző sablonokat hívhat meg egy feltételtől függően. Ebben a példában a experimental.yml YAML akkor fut, ha a paraméter experimentalTemplate igaz.

#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

Paraméter adattípusai

Adattípus	Jegyzetek
string	sztring
number	lehet korlátozni, values:különben a számszerű sztringek elfogadottak
boolean	true vagy false
object	bármilyen YAML-struktúra
step	egyetlen lépés
stepList	lépések sorozata
job	egyetlen feladat
jobList	feladatütemezés
deployment	egyetlen üzembehelyezési feladat
deploymentList	üzembehelyezési feladatok sorozata
stage	egyetlen szakasz
stageList	szakaszok sorozata

A stepList, stepList, job, jobList, deployment, deploymentList, stage és stageList adattípusok mind szabványos YAML-sémaformátumot használnak. Ez a példa sztringet, számot, logikai értéket, objektumot, lépést és stepListet tartalmaz.

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 }}

Iterálhat egy objektumon keresztül, és kinyomtathatja az objektum minden sztringét.

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

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

Emellett az objektumon belüli beágyazott elemeken keresztül is iterálhat.

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 }}

Kötelező paraméterek

A sablon elején hozzáadhat egy érvényesítési lépést a szükséges paraméterek ellenőrzéséhez.

Íme egy példa, amely a Paramétert a solution Bash használatával ellenőrzi (amely lehetővé teszi, hogy bármilyen platformon működjön):

# 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 }}

Annak megjelenítése, hogy a sablon meghiúsul, ha hiányzik a szükséges paraméter:

# 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