Definición de pipeline.parameters.parameter

Un parámetro representa un valor pasado a una canalización. Los parámetros deben incluir un valor predeterminado.

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

Definiciones que hacen referencia a esta definición: parámetros

Propiedades

name cadena. Obligatorio como primera propiedad.

displayName cadena.
nombre legible para el parámetro .

type cadena.
Vea los tipos de .

default parámetros.
Valor predeterminado; si no hay ningún valor predeterminado, el usuario DEBE proporcionar el parámetro en tiempo de ejecución.

values lista de cadenas.
Lista de valores permitidos (para algunos tipos de datos).

Observaciones

Los type campos y name son necesarios al definir parámetros. Obtenga más información sobre los tipos de datos 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

El valor type debe ser uno de los miembros enum de la tabla siguiente.

Tipo de dato	Notas
string	cuerda
number	se puede restringir a values:, de lo contrario, se acepta cualquier cadena de tipo número.
boolean	true o false
object	cualquier estructura YAML
step	un solo paso
stepList	secuencia de pasos
job	un solo trabajo
jobList	secuencia de trabajos
deployment	un único trabajo de implementación
deploymentList	secuencia de trabajos de implementación
stage	una sola fase
stageList	secuencia de fases

Los tipos de datos stepList, job, jobList, deployment, deploymentList, stage y stageList usan el formato de esquema YAML estándar. En este ejemplo se incluyen string, number, boolean, object, step y 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 }}

Ejemplos

# 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 extender una plantilla. En este ejemplo, la canalización que usa la plantilla proporciona los valores que se van a rellenar en la plantilla.

# 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 plantillas para definir parámetros y, a continuación, pase esos parámetros a una canalización.

# 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 también

Consulte plantillas para obtener más información sobre cómo trabajar con plantillas.