pipeline.parameters.parameter-Definition

Ein Parameter stellt einen Wert dar, der an eine Pipeline übergeben wird. Die Parameter müssen einen Standardwert enthalten.

parameters:
- name: string # Required as first property.
  displayName: string # Human-readable name for the parameter.
  type: string
  default: string | parameters | [ parameters ] # 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).

Definitionen, die auf diese Definition verweisen: Parameter

Eigenschaften

name Zeichenfolge. Erforderlich als erste Eigenschaft.

displayName Zeichenfolge.
lesbaren Namen für den Parameter.

type Zeichenfolge.
Siehe Typen.

default Parameter.
Standardwert; Wenn kein Standard, MUSS der Parameter vom Benutzer zur Laufzeit angegeben werden.

values Zeichenfolgenliste.
Zulässige Liste von Werten (für einige Datentypen).

Bemerkungen

Die type Felder name sind beim Definieren von Parametern erforderlich. Weitere Informationen zu 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)

Arten

Der wert type muss eines der enum Member aus der folgenden Tabelle sein.

Datentyp	Notizen
string	Schnur
number	kann auf values:beschränkt sein, andernfalls wird eine beliebige zahlähnliche Zeichenfolge akzeptiert.
boolean	true oder false
object	beliebige YAML-Struktur
step	ein einzelner Schritt
stepList	Schrittabfolge
job	ein einzelner Auftrag
jobList	Reihenfolge der Aufträge
deployment	ein einzelner Bereitstellungsauftrag
deploymentList	Abfolge von Bereitstellungsaufträgen
stage	eine einzelne Stufe
stageList	Abfolge von Stufen

Die Datentypen "stepList", "jobList", "jobList", "deploymentList", "deploymentList", "stage" und "stageList" verwenden alle das standardmäßige YAML-Schemaformat. Dieses Beispiel enthält Zeichenfolge, Zahl, Boolescher Wert, Objekt, Schritt und Schrittliste.

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

Verwenden Sie Parameter, um eine Vorlage zu erweitern. In diesem Beispiel stellt die Pipeline mit der Vorlage die Werte bereit, die in die Vorlage eingefügt werden sollen.

# File: simple-param.yml
parameters:
- name: yesNo # name of param; required
  type: boolean # data type of param; required
  default: false

steps:
- script: echo ${{ parameters.yesNo }}

# File: azure-pipelines.yml
trigger:
- main

extends:
    template: simple-param.yml
    parameters:
        yesNo: false 

Verwenden Sie Vorlagen, um Parameter zu definieren und diese Parameter dann an eine Pipeline zu übergeben.

# File: template.yml 
parameters:
  - name: environment
    type: string
    default: 'production'

jobs:
- job: Deploy
  displayName: 'Deploy to ${{ parameters.environment }}'
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - script: echo "Deploying to ${{ parameters.environment }}"
    displayName: 'Deploy Step'

# File: azure-pipelines.yml
trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

jobs:
- template: template.yml
  parameters:
    environment: 'staging'

Siehe auch

Weitere Informationen zum Arbeiten mit Vorlagen finden Sie in Vorlagen .