Partilhar via


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).
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 esta definição: parâmetros

Propriedades

name string. Obrigatório como primeira propriedade.

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

type string.
Consulte tipos.

type string.
Boolean | implantação | deploymentList | ambiente | filePath | emprego | lista de empregos | número | objeto | piscina | secureFile | serviceConnection | Palco | Lista de estágios | passo | Lista de passos | string.

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

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

Comentários

Os type campos e name são obrigatórios ao definir parâmetros. Saiba mais sobre 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 valor type deve ser um dos membros enum da tabela a seguir.

Tipo de dados Observações
string cadeia (de caracteres)
number pode ser restrito a values:, caso contrário, qualquer cadeia numérica é aceita
boolean true ou false
object qualquer estrutura YAML
step Um único passo
stepList Sequência de passos
job um único emprego
jobList Sequência de trabalhos
deployment Um único trabalho de implantação
deploymentList Sequência de trabalhos de implantação
stage uma única etapa
stageList Sequência de estágios

Os tipos de dados step, stepList, job, jobList, deployment, deploymentList, stage e stageList usam o formato de esquema YAML padrão. Este exemplo inclui 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 }}

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

Ver também

Consulte modelos para saber mais sobre como trabalhar com modelos.