pipeline.parameters.parameter definition

Parametr reprezentuje wartość przekazaną do potoku.

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

Definicje odwołujące się do tej definicji: parametry

Właściwości

name Ciąg. Wymagane jako pierwsza właściwość.

displayName Ciąg.
Czytelna dla człowieka nazwa parametru.

type Ciąg.
Zobacz typy.

default Parametry.

values lista ciągów.

Uwagi

Pola typu i nazwy są wymagane podczas definiowania parametrów. Zobacz wszystkie typy danych parametrów.

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

Wartość type musi być jednym z enum elementów członkowskich z poniższej tabeli.

Typ danych	Uwagi
string	ciąg
number	w przeciwnym razie akceptowany jest values:dowolny ciąg przypominający liczbę.
boolean	true lub false
object	dowolna struktura YAML
step	pojedynczy krok
stepList	sekwencja kroków
job	pojedyncze zadanie
jobList	sekwencja zadań
deployment	pojedyncze zadanie wdrożenia
deploymentList	sekwencja zadań wdrażania
stage	pojedynczy etap
stageList	sekwencja etapów

Wszystkie typy danych stepList, jobList, jobList, deployment, deploymentList, stage i stageList używają standardowego formatu schematu YAML. Ten przykład obejmuje ciąg, liczbę, wartość logiczną, obiekt, krok i 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 }}

Przykłady

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

Za pomocą parametrów można rozszerzyć szablon. W tym przykładzie potok używający szablonu dostarcza wartości do wypełnienia szablonu.

# 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

Zobacz też

Zobacz szablony , aby uzyskać więcej informacji na temat pracy z szablonami.