pipeline.parameters.parameter definition

参数表示传递给管道的值。

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	阶段序列

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

请参阅

有关使用模板的详细信息，请参阅模板。