Condividi tramite


definizione di pipeline.parameters.parameter

Un parametro rappresenta un valore passato a una pipeline.

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

Definizioni che fanno riferimento a questa definizione: parametri

Proprietà

name Stringa. Obbligatorio come prima proprietà.

displayName Stringa.
Nome leggibile per il parametro.

type Stringa.
Vedere tipi.

type Stringa.
boolean | distribuzione | deploymentList | ambiente | filePath | processo | jobList | numero | oggetto | pool | secureFile | serviceConnection | fase | stageList | passaggio | stepList | Stringa.

default Parametri.

values elenco di stringhe.

Commenti

I campi di tipo e nome sono necessari durante la definizione dei parametri. Vedere tutti i tipi di dati dei parametri.

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)

Tipi

Il type valore deve essere uno dei enum membri della tabella seguente.

Tipo di dati Note
string string
number può essere limitato a , in caso contrario, viene accettata qualsiasi stringa simile al values:numero
boolean true o false
object qualsiasi struttura YAML
step un singolo passaggio
stepList sequenza di passaggi
job un singolo processo
jobList sequenza di processi
deployment un singolo processo di distribuzione
deploymentList sequenza di processi di distribuzione
stage una singola fase
stageList sequenza di fasi

Il passaggio, stepList, processo, jobList, distribuzione, deploymentList, fase e tipi di dati stageList usano tutti il formato di schema YAML standard. Questo esempio include string, number, boolean, object, step e 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 }}

Esempio

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

È possibile usare i parametri per estendere un modello. In questo esempio la pipeline che usa il modello fornisce i valori da compilare nel modello.

# 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

Vedi anche

Per altre informazioni sull'uso dei modelli, vedere modelli .