definisi pipeline.parameters.parameter

Parameter mewakili nilai yang diteruskan ke alur.

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

Definisi yang mereferensikan definisi ini: parameter

Properti

name String. Diperlukan sebagai properti pertama.

displayName String.
Nama yang dapat dibaca manusia untuk parameter .

type String.
Lihat jenis.

type String.
boolean | penyebaran | deploymentList | lingkungan | filePath | pekerjaan | jobList | angka | objek | pool | secureFile | serviceConnection | tahap | stageList | langkah | stepList | String.

default Parameter.

values daftar string.

Keterangan

Bidang jenis dan nama diperlukan saat menentukan parameter. Lihat semua jenis data parameter.

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)

Jenis

Nilai type harus salah satu enum anggota dari tabel berikut.

Jenis Data Catatan
string string
number dapat dibatasi untuk values:, jika tidak, string seperti angka diterima
boolean true atau false
object struktur YAML apa pun
step satu langkah
stepList urutan langkah-langkah
job satu pekerjaan
jobList urutan pekerjaan
deployment satu pekerjaan penyebaran
deploymentList urutan pekerjaan penyebaran
stage satu tahap
stageList urutan tahapan

Jenis data step, stepList, job, jobList, deployment, deploymentList, stage, dan stageList semuanya menggunakan format skema YAML standar. Contoh ini mencakup string, angka, boolean, objek, langkah, dan 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 }}

Contoh

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

Anda dapat menggunakan parameter untuk memperluas templat. Dalam contoh ini, alur yang menggunakan templat memasok nilai untuk diisi ke dalam templat.

# 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

Lihat juga

Lihat templat untuk informasi selengkapnya tentang bekerja dengan templat.