definição pipeline.parameters.parameter

Um parâmetro representa um valor transmitido para um pipeline.

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

Definições que referenciam esta definição: parâmetros

Propriedades

name cadeia. Necessário como primeira propriedade.

displayName cadeia.
Nome legível por humanos para o parâmetro.

type cadeia.
Ver tipos.

default parâmetros.

values lista de cadeias.

Observações

Os campos de tipo e nome são necessários ao definir parâmetros. Veja todos os tipos de dados de parâmetros.

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)

Tipos

O type valor tem de ser um dos enum membros da tabela seguinte.

Tipo de dados	Notas
string	string
number	pode ser restringido a values:, caso contrário, qualquer cadeia de carateres semelhante a um número é aceite
boolean	true ou false
object	qualquer estrutura YAML
step	um único passo
stepList	sequência de passos
job	uma única tarefa
jobList	sequência de tarefas
deployment	uma única tarefa de implementação
deploymentList	sequência de tarefas de implementação
stage	uma única fase
stageList	sequência de fases

Os tipos de dados stepList, stepList, job, jobList, deployment, deploymentList, stage e stageList utilizam o formato de esquema YAML padrão. Este exemplo inclui cadeia, número, booleano, objeto, passo 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 }}

Exemplos

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

Pode utilizar parâmetros para expandir um modelo. Neste exemplo, o pipeline que utiliza o modelo fornece os valores a preencher no modelo.

# 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

Ver também

Veja modelos para obter mais informações sobre como trabalhar com modelos.