pipeline.parameters.parameter definition

Um parâmetro representa um valor passado 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 fazem referência a essa definição: parâmetros

Propriedades

name String. Obrigatório como primeira propriedade.

displayName String.
Nome legível para o parâmetro.

type String.
Consulte tipos.

default Parâmetros.

values lista de cadeias de caracteres.

Comentários

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

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 valor type deve ser um dos membros enum da tabela a seguir.

Tipo de dados	Observações
string	string
number	pode ser restrito a values:, caso contrário, qualquer cadeia de caracteres semelhante a número será aceita
boolean	true ou false
object	qualquer estrutura do YAML
step	uma etapa única
stepList	sequência de etapas
job	um trabalho único
jobList	sequência de trabalhos
deployment	um trabalho de implantação única
deploymentList	sequência de trabalhos de implantação
stage	uma fase única
stageList	sequência de fases

Os tipos de dados de fase, stepList, trabalho, jobList, implantação, deploymentList, fase e stageList usam o formato de esquema YAML padrão. Este exemplo inclui cadeia de caracteres, número, booliano, objeto, etapa 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 }}```

Você pode usar parâmetros para estender um modelo. Neste exemplo, o pipeline que usa o modelo fornece os valores a serem preenchidos 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

Confira também

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