pipeline.parameters.parameter definition

En parameter representerar ett värde som skickas till en pipeline.

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

Definitioner som refererar till den här definitionen: parametrar

Egenskaper

name Sträng. Krävs som första egenskap.

displayName Sträng.
Läsbart namn för parametern.

type Sträng.
Se typer.

default Parametrar.

values stränglista.

Kommentarer

Fälten typ och namn krävs när parametrar definieras. Se alla parameterdatatyper.

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)

Typer

Värdet type måste vara en av enum medlemmarna i följande tabell.

Datatyp	Kommentarer
string	sträng
number	kan begränsas till values:, annars accepteras en talliknande sträng
boolean	true eller false
object	valfri YAML-struktur
step	ett enda steg
stepList	sekvens med steg
job	ett enda jobb
jobList	sekvens med jobb
deployment	ett enda distributionsjobb
deploymentList	sekvens med distributionsjobb
stage	ett enda steg
stageList	sekvens av faser

Datatyperna step, stepList, job, jobList, deployment, deploymentList, stage och stageList använder alla yaml-standardschemaformat. Det här exemplet innehåller sträng, tal, booleskt värde, objekt, steg och 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 }}

Exempel

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

Du kan använda parametrar för att utöka en mall. I det här exemplet tillhandahåller pipelinen med mallen de värden som ska fyllas i i mallen.

# 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

Se även

Mer information om hur du arbetar med mallar finns i mallar .