Определение pipeline.parameters.parameter

Параметр представляет значение, переданное конвейеру.

parameters:
- name: string # Required as first property.
  displayName: string # Human-readable name for the parameter.
  type: string
  default: string | parameters | [ parameters ]
  values: [ string ]

Определения, ссылающиеся на это определение: параметры

Свойства

строка name. Обязательный в качестве первого свойства.

строка displayName.
удобочитаемое пользователем имя параметра.

строка type.
см.типов.

default параметры.

values строковый список.

Замечания

Поля типа и имени требуются при определении параметров. См. все типы данных параметров.

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)

Типы

Значение type должно быть одним из элементов enum из следующей таблицы.

Тип данных	Примечания
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 }}

Примеры

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

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

# 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 

См. также

Дополнительные сведения о работе с шаблонами см. в шаблонах.