Definice Pipeline.parameters.Parameter

Parametr představuje hodnotu předanou kanálu. Parametry musí obsahovat výchozí hodnotu.

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

Definice, které odkazují na tuto definici: parametry

Vlastnosti

name řetězec. Povinné jako první vlastnost.

displayName řetězec.
název parametru čitelný pro člověka.

type řetězec.
Zobrazit typy .

default parametry.
Výchozí hodnota; pokud není výchozí, pak parametr MUSÍ být zadán uživatelem za běhu.

values seznam řetězců.
Povolený seznam hodnot (pro některé datové typy).

Poznámky

Pole type a name pole jsou vyžadovány při definování parametrů. Přečtěte si další informace o datových typech parametrů.

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)

Typy

Hodnota type musí být jedním z enum členů z následující tabulky.

Datový typ	Poznámky
string	řetězec
number	může být omezeno na values:, jinak se přijme jakýkoli řetězec podobný číslu.
boolean	true nebo false
object	libovolná struktura YAML
step	jeden krok
stepList	posloupnost kroků
job	jedna úloha
jobList	pořadí úloh
deployment	jedna úloha nasazení
deploymentList	posloupnost úloh nasazení
stage	jedna fáze
stageList	posloupnost fází

Všechny datové typy stepList, stepList, jobList, deployment, deploymentList, stage a stageList používají standardní formát schématu YAML. Tento příklad obsahuje řetězec, číslo, logickou hodnotu, objekt, krok a 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 }}

Příklady

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

K rozšíření šablony použijte parametry. V tomto příkladu kanál pomocí šablony poskytuje hodnoty, které se mají vyplnit do šablony.

# 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 

Pomocí šablon můžete definovat parametry a pak tyto parametry předat kanálu.

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

Viz také

Další informace o práci se šablonami najdete v šablonách .