pipeline.parameters.parameter definition

A paraméter egy folyamatnak átadott értéket jelöl.

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

A definícióra hivatkozó definíciók: paraméterek

Tulajdonságok

name Karakterlánc. Első tulajdonságként kötelező megadni.

displayName Karakterlánc.
A paraméter ember által olvasható neve.

type Karakterlánc.
Típusok megtekintése.

type Karakterlánc.
logikai | üzembe helyezés | deploymentList | környezet | filePath | feladat | jobList | szám | objektum | készlet | secureFile | serviceConnection | szakasz | stageList | lépés | stepList | Karakterlánc.

default Paraméterek.

values sztringlista.

Megjegyzések

A paraméterek definiálásakor a típus- és névmezőkre van szükség. Tekintse meg az összes paraméteradattípust.

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ípusok

Az type értéknek az enum alábbi táblázat egyik tagjának kell lennie.

Adattípus Jegyzetek
string sztring
number lehet, hogy a -ra korlátozódik values:, ellenkező esetben bármely számszerű sztring elfogadott
boolean true vagy false
object bármilyen YAML-struktúra
step egyetlen lépés
stepList lépések sorozata
job egyetlen feladat
jobList feladatütemezés
deployment egyetlen üzembehelyezési feladat
deploymentList üzembehelyezési feladatok sorozata
stage egyetlen szakasz
stageList szakaszok sorozata

A stepList, stepList, job, jobList, deployment, deploymentList, stage és stageList adattípusok mind szabványos YAML-sémaformátumot használnak. Ez a példa sztringet, számot, logikai értéket, objektumot, lépést és stepListet tartalmaz.

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

Példák

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

A paraméterekkel bővítheti a sablonokat. Ebben a példában a sablont használó folyamat adja meg a sablonba kitöltendő értékeket.

# 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

Lásd még

A sablonok használatával kapcsolatos további információkért tekintse meg a sablonokat .