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

另請參閱

如需使用範本的詳細資訊，請參閱 範本 。