다음을 통해 공유


pipeline.parameters.parameter 정의

매개 변수는 파이프라인에 전달된 값을 나타냅니다. 매개 변수에는 기본값이 포함되어야 합니다.

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 ]

이 정의를 참조하는 정의: 매개 변수

속성

name 문자열입니다. 첫 번째 속성으로 필요합니다.

displayName 문자열입니다.
매개 변수의 사람이 읽을 수 있는 이름을 .

type 문자열입니다.
형식참조하세요.

type 문자열입니다.
부울 | 배포 | deploymentList | 환경 | filePath | job | jobList | number | object | pool | secureFile | serviceConnection | stage | stageList | 단계 | stepList | 문자열.

default 매개 변수입니다.
기본값; 기본값이 없는 경우 런타임에 사용자가 매개변수를 제공해야 합니다.

values 문자열 목록입니다.
허용되는 값 목록(일부 데이터 형식의 경우).

발언

type 매개 변수를 정의할 때는 필드와 name 필드가 필요합니다. 매개 변수 데이터 형식에 대해 자세히 알아봅니다.

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)

형식

type 값은 다음 표의 enum 멤버 중 하나여야 합니다.

데이터 형식 노트
string 문자열
number values:제한될 수 있습니다. 그렇지 않으면 숫자와 유사한 문자열이 허용됩니다.
boolean true 또는 false
object YAML 구조체
step 단일 단계
stepList 단계 시퀀스
job 단일 작업
jobList 작업 시퀀스
deployment 단일 배포 작업
deploymentList 배포 작업 시퀀스
stage 단일 단계
stageList 단계 시퀀스

단계, stepList, 작업, jobList, 배포, deploymentList, stage 및 stageList 데이터 형식은 모두 표준 YAML 스키마 형식을 사용합니다. 이 예제에는 문자열, 숫자, 부울, 개체, 단계 및 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 }}

예제

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

매개 변수를 사용하여 템플릿을 확장합니다. 이 예제에서 템플릿을 사용하는 파이프라인은 템플릿에 채울 값을 제공합니다.

# 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 

템플릿을 사용하여 매개 변수를 정의한 다음 해당 매개 변수를 파이프라인에 전달합니다.

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

참고 항목

템플릿 작업에 대한 자세한 내용은 템플릿을 참조하세요.