Mallparametrar

Artikel
03/24/2025

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 vidare 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 inom datatypen för parametern jobList, deploymentList eller stageList.

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öegenskapsobjekt templateContext kan du få en YAML-fil som är mer underhållbar och lättare att förstå.

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 }}:  # Iterate over each job in the 'testSet' parameter
  - ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 200) }}: # Check if the HTTP response is 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) }}: # Check if the HTTP response is 500
    - job:
      steps:
      - powershell: 'Get-ChildItem -Path Env:\' # Run a PowerShell script to list environment variables
      - ${{ testJob.steps }} # Include additional steps from the 'testJob' object

#azure-pipeline.yml

trigger: none

pool:
  vmImage: ubuntu-latest

extends:
  template: testing-template.yml 
  parameters:
    testSet:  # Define the 'testSet' parameter to pass to the template
    - job: positive_test # Define a job named 'positive_test'
      templateContext:
        expectedHTTPResponseCode: 200 # Set the expected HTTP response code to 200 for this job
      steps:
      - script: echo "Run positive test" 
    - job: negative_test # Define a job named 'negative_test'
      templateContext:
        expectedHTTPResponseCode: 500 # Set the expected HTTP response code to 500 for this job
      steps:
      - script: echo "Run negative test"

Parametrar för att välja en mall under 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) }}: # Check if 'experimentalTemplate' is true
  - template: experimental.yml
- ${{ if not(eq(parameters.experimentalTemplate, true)) }}:  # Check if 'experimentalTemplate' is not true
  - template: stable.yml

Parameterdatatyper

Datatyp	Anteckningar
`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 av jobb
`deployment`	ett enda distributionsjobb
`deploymentList`	sekvens av distributionsjobb
`stage`	ett enda steg
`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  # Define a parameter named 'myString'
  type: string  # The parameter type is string
  default: a string  # Default value is 'a string'

- name: myMultiString  # Define a parameter named 'myMultiString'
  type: string  # The parameter type is string
  default: default  # Default value is 'default'
  values:  # Allowed values for 'myMultiString'
  - default  
  - ubuntu  

- name: myNumber  # Define a parameter named 'myNumber'
  type: number  # The parameter type is number
  default: 2  # Default value is 2
  values:  # Allowed values for 'myNumber'
  - 1  
  - 2  
  - 4  
  - 8  
  - 16  

- name: myBoolean  # Define a parameter named 'myBoolean'
  type: boolean  # The parameter type is boolean
  default: true  # Default value is true

- name: myObject  # Define a parameter named 'myObject'
  type: object  # The parameter type is object
  default:  # Default value is an object with nested properties
    foo: FOO  # Property 'foo' with value 'FOO'
    bar: BAR  # Property 'bar' with value 'BAR'
    things:  # Property 'things' is a list
    - one  
    - two  
    - three  
    nested:  # Property 'nested' is an object
      one: apple  # Property 'one' with value 'apple'
      two: pear  # Property 'two' with value 'pear'
      count: 3  # Property 'count' with value 3

- name: myStep  # Define a parameter named 'myStep'
  type: step  # The parameter type is step
  default:  # Default value is a step
    script: echo my step 

- name: mySteplist  # Define a parameter named 'mySteplist'
  type: stepList  # The parameter type is stepList
  default:  # Default value is a list of steps
    - script: echo step one  
    - script: echo step two  

trigger: none  

jobs: 
- job: stepList  # Define a job named 'stepList'
  steps: ${{ parameters.mySteplist }}  # Use the steps from the 'mySteplist' parameter

- job: myStep  # Define a job named 'myStep'
  steps:
    - ${{ parameters.myStep }}  # Use the step from the 'myStep' parameter

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 }}: # Iterate over each value in the 'listOfStrings' parameter
  - script: echo ${{ value }} # Output the current value in the iteration

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 }} : # Iterate over each fruit in the 'listOfFruits'
  - ${{ each fruitColor in fruit.colors}} : # Iterate over each color in the current fruit's colors
    - script: echo ${{ fruit.fruitName}} ${{ fruitColor }} # Echo the current fruit's name and color

Du kan också referera direkt till ett objekts nycklar och motsvarande värden.

parameters:
  - name: myObject
    type: object
    default:
      key1: 'value1'
      key2: 'value2'
      key3: 'value3'

jobs:
- job: ExampleJob
  displayName: 'Example object parameter job'
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - script: |
      echo "Keys in myObject:"
      echo "Key1: ${{ parameters.myObject.key1 }}"
      echo "Key2: ${{ parameters.myObject.key2 }}"
      echo "Key3: ${{ parameters.myObject.key3 }}"
    displayName: 'Display object keys and values'

Obligatoriska parametrar

Pipelines rapporterar automatiskt ett fel om en parameter saknas. Du kan lägga till ett valideringssteg i början av mallen för att söka efter de parametrar du behöver och vidta lämpliga åtgärder.

Här är ett exempel som söker efter parametern solution med hjälp av Bash:

# 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

Dela via