definizione di pipeline.parameters.parameter

2025-07-14

Un parametro rappresenta un valore passato a una pipeline. I parametri devono includere un valore predefinito.

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

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

default parametri.
Valore predefinito; se non è presente alcun valore predefinito, il parametro DEVE essere fornito dall'utente in fase di esecuzione.

values elenco di stringhe.
Elenco di valori consentiti (per alcuni tipi di dati).

Osservazioni

I type campi e name sono obbligatori quando si definiscono i parametri. Altre informazioni sui 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 valore type deve essere uno dei membri enum della tabella seguente.

Tipo di dati	Note
`string`	corda
`number`	può essere limitato a `values:`; in caso contrario, viene accettata qualsiasi stringa simile a un 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

I tipi di dati step, stepList, jobList, deployment, deploymentList, stage e 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 }}

Esempi

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

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

Usare i modelli per definire i parametri e quindi passare tali parametri a una pipeline.

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

Vedere anche

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