pipeline.parameters.parameter definition

Parametre, işlem hattına geçirilen bir değeri temsil eder.

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

Bu tanıma başvuran tanımlar: parametreler

Özellikler

name Dize. İlk özellik olarak gereklidir.

displayName Dize.
parametresi için okunabilir ad.

type Dize.
Bkz. türler.

default Parametre.

values dize listesi.

Açıklamalar

Parametre tanımlarken tür ve ad alanları gereklidir. Tüm parametre veri türlerini görün.

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)

Türler

Değer, type aşağıdaki tabloda yer alan enum üyelerden biri olmalıdır.

Veri türü	Notlar
string	string
number	ile kısıtlanabilir values:, aksi takdirde sayı benzeri herhangi bir dize kabul edilir
boolean	true veya false
object	herhangi bir YAML yapısı
step	tek bir adım
stepList	adım dizisi
job	tek bir iş
jobList	iş sırası
deployment	tek bir dağıtım işi
deploymentList	dağıtım işlerinin sırası
stage	tek aşama
stageList	aşama dizisi

Step, stepList, job, jobList, deployment, deploymentList, stage ve stageList veri türlerinin tümü standart YAML şema biçimini kullanır. Bu örnek dize, sayı, boole, nesne, adım ve stepList'i içerir.

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

Örnekler

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

Bir şablonu genişletmek için parametreleri kullanabilirsiniz. Bu örnekte, şablonu kullanan işlem hattı, şablona doldurulacak değerleri sağlar.

# 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

Ayrıca bkz.

Şablonlarla çalışma hakkında daha fazla bilgi için şablonlara bakın.