definição pipeline.parameters.parameter

Um parâmetro representa um valor passado para um pipeline. Os parâmetros devem incluir um valor padrão.

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

Definições que fazem referência a essa definição: parâmetros

Propriedades

name cadeia de caracteres. Obrigatório como primeira propriedade.

displayName cadeia de caracteres.
nome legível para o parâmetro.

type cadeia de caracteres.
Ver tipos .

default parâmetros.
Valor padrão; se não houver padrão, o parâmetro DEVE ser fornecido pelo usuário em tempo de execução.

values lista de cadeias de caracteres.
Lista permitida de valores (para alguns tipos de dados).

Observações

Os type campos e os campos name são necessários ao definir parâmetros. Saiba mais sobre os tipos de dados de 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 dado	Anotações
string	cadeia
number	pode ser restrito a values:, caso contrário, qualquer cadeia de caracteres semelhante a número é aceita
boolean	true ou false
object	qualquer estrutura YAML
step	uma única etapa
stepList	sequência de etapas
job	um único trabalho
jobList	sequência de trabalhos
deployment	um único trabalho de implantação
deploymentList	sequência de trabalhos de implantação
stage	um único estágio
stageList	sequência de estágios

Os tipos de dados stepList, stepList, job, jobList, deployment, deploymentList, stage 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 }}

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

Use modelos para definir parâmetros e, em seguida, passe esses parâmetros para um 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'

Consulte também

Consulte modelos para saber mais sobre como trabalhar com modelos.