Definitie van pipeline.parameters.parameter

Een parameter vertegenwoordigt een waarde die wordt doorgegeven aan een pijplijn. Parameters moeten een standaardwaarde bevatten.

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).

Definities die naar deze definitie verwijzen: parameters

Eigenschappen

name tekenreeks. Vereist als eerste eigenschap.

displayName tekenreeks.
leesbare naam voor de parameter.

type tekenreeks.
Zie typen.

default Parameters.
Standaardwaarde; als er geen standaard is, MOET de parameter tijdens runtime door de gebruiker worden opgegeven.

values lijst met tekenreeksen.
Toegestane lijst met waarden (voor sommige gegevenstypen).

Opmerkingen

De type velden en name velden zijn vereist bij het definiëren van parameters. Meer informatie over parametergegevenstypen.

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

De type-waarde moet een van de enum leden uit de volgende tabel zijn.

Gegevenstype	Notities
string	snaar
number	kan worden beperkt tot values:, anders wordt een willekeurige tekenreeks als een getal geaccepteerd
boolean	true of false
object	elke YAML-structuur
step	één stap
stepList	reeks stappen
job	één taak
jobList	reeks taken
deployment	één implementatietaak
deploymentList	volgorde van implementatietaken
stage	één fase
stageList	reeks fasen

De stap, stepList, job, jobList, deployment, deploymentList, stage en stageList-gegevenstypen maken allemaal gebruik van de standaard YAML-schema-indeling. Dit voorbeeld bevat tekenreeks, getal, booleaanse waarde, object, stap en 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 }}

Voorbeelden

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

Parameters gebruiken om een sjabloon uit te breiden. In dit voorbeeld levert de pijplijn met behulp van de sjabloon de waarden die in de sjabloon moeten worden ingevuld.

# 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 

Gebruik sjablonen om parameters te definiëren en deze parameters vervolgens door te geven aan een pijplijn.

# 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'

Zie ook

Zie sjablonen voor meer informatie over het werken met sjablonen.