Параметры шаблона

Параметры и их типы данных можно указать в шаблоне и ссылаться на эти параметры в конвейере. С помощью templateContext можно также передать свойства этапам, шагам и заданиям, которые используются в качестве параметров в шаблоне.

Кроме того , можно использовать параметры за пределами шаблонов. Можно использовать только литералы для значений по умолчанию параметров. Дополнительные сведения о параметрах схемы YAML.

Передача параметров

Параметры должны содержать имя и тип данных. В azure-pipelines.ymlслучае, если параметр yesNo имеет логическое значение, сборка завершается успешно. Если yesNo задано значение строки, например apples, сборка завершается ошибкой.

# 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

Использование templateContext для передачи свойств шаблонам

Можно использовать templateContext для передачи дополнительных свойств этапам, шагам и заданиям, которые используются в качестве параметров в шаблоне. В частности, можно указать templateContext в типе deploymentListjobListданных параметра или stageList параметре.

Вы можете использовать templateContext , чтобы упростить настройку сред при обработке каждого задания. Объединяя задание и объект свойств среды вместе, templateContext вы можете повысить удобство обслуживания и упростить понимание YAML.

В этом примере параметр testSet имеет testing-template.yml тип jobListданных. Шаблон testing-template.yml создает новую переменную testJob с помощью каждого ключевое слово. Затем шаблон ссылается на testJob.templateContext.expectedHTTPResponseCodeобъект, который получает набор azure-pipeline.yml и передается в шаблон.

Если код ответа равен 200, шаблон выполняет запрос REST. Если код ответа равен 500, шаблон выводит все переменные среды для отладки.

templateContext может содержать свойства.

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

Параметры для выбора шаблона во время выполнения

Можно вызывать разные шаблоны из YAML конвейера в зависимости от условия. В этом примере experimental.yml YAML запускается, когда параметр experimentalTemplate имеет значение true.

#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

Типы данных параметров

Тип данных	Примечания.
string	строка
number	может быть ограничено, в противном случае принимается любая строка, похожая на values:число
boolean	true или false
object	любая структура YAML
step	один шаг
stepList	последовательность шагов
job	одно задание
jobList	последовательность заданий
deployment	одно задание развертывания
deploymentList	последовательность заданий развертывания
stage	один этап
stageList	последовательность этапов

Шаг, stepList, job, jobList, deployment, deploymentList, stage и stageList все типы данных используют стандартный формат схемы YAML. Этот пример включает строку, число, логическое значение, объект, шаг и 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 }}

Вы можете выполнить итерацию по объекту и распечатать каждую строку в объекте.

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

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

Кроме того, можно итерировать вложенные элементы в объекте.

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

Обязательные параметры

Вы можете добавить шаг проверки в начале шаблона, чтобы проверка для необходимых параметров.

Ниже приведен пример, который проверка для solution параметра с помощью 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 }}

Чтобы показать, что шаблон завершается ошибкой, если он отсутствует обязательный параметр:

# 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