Определение 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 Строка.
См. типы.

type Строка.
boolean | развертывание | deploymentList | среда | filePath | job | JobList | number | объект | пул | secureFile | serviceConnection | stage | stageList | шаг | stepList | Строка.

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 последовательность этапов

Типы данных step, stepList, job, jobList, deployment, deploymentList, stage и stageList используют стандартный формат схемы YAML. Этот пример включает string, number, boolean, object, step и 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 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

См. также раздел

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