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 ]

この定義を参照する定義: parameters

プロパティ

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 メンバーである必要があります。

データ型	Notes
string	string
number	values: に制限される場合があります。それ以外の場合は、任意の数値のような文字列が受け入れられます
boolean	true または false
object	任意の YAML 構造体
step	1 つのステップ
stepList	ステップのシーケンス
job	1 つのジョブ
jobList	ジョブのシーケンス
deployment	1 つのデプロイ ジョブ
deploymentList	デプロイ ジョブのシーケンス
stage	1 つのステージ
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

関連項目

テンプレートの使用について詳しくは、テンプレートに関する記事をご覧ください。