pipeline.parameters.parameter definition

Ein Parameter stellt einen Wert dar, der an eine Pipeline übergeben wird.

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

Definitionen, die auf diese Definition verweisen: Parameter

Eigenschaften

name Schnur. Erforderlich als erste Eigenschaft.

displayName Schnur.
Für den Parameter lesbarer Name.

type Schnur.
Siehe Typen.

default Parameter.

values Zeichenfolgenliste.

Bemerkungen

Die Typ- und Namensfelder sind beim Definieren von Parametern erforderlich. Siehe Informationen zu allen Parameterdatentypen.

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)

Typen

Der type-Wert muss einer der enum-Member aus der folgenden Tabelle sein.

Datentyp	Notizen
string	Zeichenfolge
number	kann auf values: beschränkt sein, andernfalls wird eine beliebige zahlenähnliche Zeichenfolge akzeptiert
boolean	true oder false
object	beliebige YAML-Struktur
step	ein einzelner Schritt
stepList	Sequenz von Schritten
job	ein einzelner Auftrag
jobList	Sequenz von Aufträgen
deployment	ein einzelner Bereitstellungsauftrag
deploymentList	Sequenz von Bereitstellungsaufträgen
stage	eine einzelne Stage
stageList	Sequenz von Stages

Die Datentypen „step“, „stepList“, „jobList“, „deployment“, „deploymentList“, „stage“ und „stageList“ verwenden alle standardmäßige YAML-Schemaformate. Dieses Beispiel umfasst „string“, „number“, „boolean“, „object“, „step“ und „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 }}

Beispiele

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

Sie können Parameter verwenden, um eine Vorlage zu erweitern. In diesem Beispiel stellt die Pipeline, die die Vorlage verwendet, die Werte bereit, mit denen die Vorlage gefüllt werden soll.

# 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

Weitere Informationen

Weitere Informationen zum Arbeiten mit Vorlagen finden Sie unter Vorlagen.