definice pipeline.parameters.parameter

Parametr představuje hodnotu předanou kanálu.

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

Definice, které odkazují na tuto definici: parametry

Vlastnosti

name Řetězec. Povinný argument jako první vlastnost.

displayName Řetězec.
Název parametru čitelný pro člověka.

type Řetězec.
Viz typy.

default Parametry.

values seznam řetězců.

Poznámky

Pole typu a názvu se vyžadují při definování parametrů. Podívejte se na všechny datové typy parametrů.

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)

Typy

Hodnota type musí být jeden ze enum členů z následující tabulky.

Datový typ	Poznámky
string	řetězec
number	může být omezen na values:, jinak se přijme jakýkoli řetězec podobný číslům.
boolean	true nebo false
object	libovolná struktura YAML
step	jeden krok
stepList	posloupnost kroků
job	jedna úloha
jobList	pořadí úloh
deployment	jedna úloha nasazení
deploymentList	pořadí úloh nasazení
stage	jedna fáze
stageList	posloupnost fází

Všechny datové typy step, stepList, jobList, deploymentList, stage a stageList používají standardní formát schématu YAML. Tento příklad zahrnuje řetězec, číslo, logickou hodnotu, objekt, krok a 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 }}

Příklady

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

K rozšíření šablony můžete použít parametry. V tomto příkladu kanál používající šablonu poskytuje hodnoty, které se mají do šablony vyplnit.

# 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

Viz také

Další informace o práci se šablonami najdete v tématu šablony .