Çalışma zamanı parametreleri

Makale
07/20/2023

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

Çalışma zamanı parametreleri, işlem hattına geçirilebilen değerler üzerinde daha fazla denetim sahibi olmanıza olanak tanır. Çalışma zamanı parametreleriyle:

Çalışma zamanında betiklere ve görevlere farklı değerler sağlama
Parametre türlerini, izin verilen aralıkları ve varsayılanları denetleme
Şablon ifadeleriyle işleri ve aşamaları dinamik olarak seçme

Şablonlardaki ve işlem hattındaki parametreleri belirtebilirsiniz. Parametreler sayı ve dize gibi veri türlerine sahiptir ve değerlerin bir alt kümesiyle sınırlandırılabilir. parameters YAML'deki bölüm hangi parametrelerin kullanılabilir olduğunu tanımlar.

Parametreler yalnızca şablon ayrıştırma zamanında kullanılabilir. parametreler işlem hattı çalışmadan hemen önce genişletilir, böylece ile çevrelenen ${{ }} değerler parametre değerleriyle değiştirilir. İşlem hattı çalıştırmanız sırasında değerlerinizin daha yaygın olarak kullanılabilir olmasını istiyorsanız değişkenleri kullanın.

Not

Bu kılavuz klasik işlem hatları için geçerli değildir. Klasik işlem hatlarındaki parametreler için bkz . İşlem parametreleri (klasik).

Parametreler bir ad ve veri türü içermelidir. Parametreler isteğe bağlı olamaz. YAML dosyanızda veya işlem hattınızı çalıştırdığınızda varsayılan bir değer atanmalıdır. Varsayılan bir değer atamıyorsanız veya olarak ayarlanmıyorsanız defaultfalse, kullanılabilir ilk değer kullanılır.

Şablonda parametre olarak kullanılan aşamalara, adımlara ve işlere fazladan özellikler geçirmek için templateContext kullanın.

İşlem hatlarında parametreleri kullanma

YAML'nin başında çalışma zamanı parametrelerini ayarlayın.

Bu örnek işlem hattı, üç barındırılan aracıyı seçenek olarak string içeren bir image parametre içerir. İşler bölümünde değeri, pool işi çalıştırmak için kullanılan parametreden aracıyı belirtir. trigger yok olarak ayarlanır, böylece işlem hattınızı el ile çalıştırılacak şekilde tetiklerken değerini image seçebilirsiniz.

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 building $(Build.BuildNumber) with ${{ parameters.image }}

İşlem hattı çalıştırıldığında Havuz Görüntüsü'ne tıklayın. Seçim yapmazsanız varsayılan seçenek ubuntu-latest kullanılır.

çalışma zamanı parametreleri

Parametrelerle koşullu kullanım

Parametreleri koşullu mantığın bir parçası olarak da kullanabilirsiniz. Koşullu olarak, ölçütlere uyuyorsa YAML'nin if bir bölümü çalıştırılır.

Hangi adımların çalıştırdığını belirlemek için parametreleri kullanma

Bu işlem hattı, testişlem hattında test çalıştırılıp çalıştırılmayacağını denetlemek için kullanılabilen ikinci bir boole parametresi ekler. değeri test true olduğunda , Tüm testleri çalıştırma çıkışını veren adım çalıştırılır.

parameters:
- name: image
  displayName: Pool Image
  values:
  - windows-latest
  - ubuntu-latest
  - macOS-latest
- name: test
  displayName: Run Tests?
  type: boolean
  default: false

trigger: none

jobs:
- job: build
  displayName: Build and Test
  pool: 
    vmImage: ${{ parameters.image }}
  steps:
  - script: echo building $(Build.BuildNumber)
  - ${{ if eq(parameters.test, true) }}:
    - script: echo "Running all the tests"

Hangi yapılandırmanın kullanılacağını ayarlamak için parametreleri kullanma

Ayrıca, hangi işin çalıştırıldığına ayarlamak için parametreleri de kullanabilirsiniz. Bu örnekte, bir tür olan string parametrenin değerine config bağlı olarak farklı mimariler oluşturulur. Varsayılan olarak, hem hem de x86x64 mimarileri derlenmiştir.

parameters:
- name: configs
  type: string
  default: 'x86,x64'

trigger: none

jobs:
- ${{ if contains(parameters.configs, 'x86') }}:
  - job: x86
    steps:
    - script: echo Building x86...
- ${{ if contains(parameters.configs, 'x64') }}:
  - job: x64
    steps:
    - script: echo Building x64...
- ${{ if contains(parameters.configs, 'arm') }}:
  - job: arm
    steps:
    - script: echo Building arm...

Bir aşamayı seçmeli olarak dışlama

Aşamanın çalıştırılıp çalıştırılmayacağını ayarlamak için parametreleri de kullanabilirsiniz. Bu örnekte, dört aşaması ve her aşama için farklı işleri olan bir işlem hattı vardır. Parametre runPerfTests true ise Performans Testi aşaması çalışır. varsayılan değeri runPerfTests false olduğundan, herhangi bir güncelleştirme olmadan dört aşamadan yalnızca üçü çalıştırılır.

parameters:
- name: runPerfTests
  type: boolean
  default: false

trigger: none

stages:
- stage: Build
  displayName: Build
  jobs:
  - job: Build
    steps:
    - script: echo running Build


- stage: UnitTest
  displayName: Unit Test
  dependsOn: Build
  jobs:
  - job: UnitTest
    steps:
    - script: echo running UnitTest


- ${{ if eq(parameters.runPerfTests, true) }}:
  - stage: PerfTest
    displayName: Performance Test
    dependsOn: Build
    jobs:
    - job: PerfTest
      steps:
      - script: echo running PerfTest


- stage: Deploy
  displayName: Deploy
  dependsOn: UnitTest
  jobs:
  - job: Deploy
    steps:
    - script: echo running UnitTest

Parametreler arasında döngü oluşturma

Dize, sayı ve boole parametrelerinizde de döngü yapabilirsiniz.

Komut Dosyası
PowerShell

Bu örnekte, parametreleri döngüye alır ve her parametrenin adını ve değerini yazdırırsınız. Dört farklı parametre vardır ve her biri farklı bir türü temsil eder. myStringName tek satırlı bir dizedir. myMultiString çok satırlı bir dizedir. myNumber is a number. myBoolean boole değeridir. Adımlar bölümünde, betik görevleri her parametrenin anahtarını ve değerini verir.

# start.yaml
parameters:
- name: myStringName
  type: string
  default: a string value
- 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

steps: 
- ${{ each parameter in parameters }}:
  - script: echo ${{ parameter.Key }} 
  - script: echo ${{ parameter.Value }}

# azure-pipeline.yaml
trigger: none

extends:
  template: start.yaml

Bu örnekte, parametreleri döngüye alır ve her parametrenin adını ve değerini yazdırırsınız. Dört farklı parametre vardır ve her biri farklı bir türü temsil eder. myStringName tek satırlı bir dizedir. myMultiString çok satırlı bir dizedir. myNumber is a number. myBoolean boole değeridir. Adımlar bölümünde, bir PowerShell görevinde parametreler arasında döngü kurar ve her parametreyi bir ortam değişkeni olarak ayarlarsınız.

# start.yaml

parameters:
- name: myStringName
  type: string
  default: a string value
- 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

steps: 
  - task: PowerShell@2
    env:
      ${{ each parameter in parameters }}:
        ${{ parameter.Key }}: ${{ parameter.Value }}
    inputs:
      filePath: test_script.ps1
      pwsh: true

# azure-pipeline.yaml
trigger: none

extends:
  template: start.yaml

# test_script.ps1

Write-Host "Hello, World!"
Write-Host $env:myStringName

Boş parametre nesnesi olup olmadığını denetleme

bir nesne parametresinin değeri olup olmadığını denetlemek için ifadeyilength() kullanabilirsiniz.

parameters:
- name: foo
  type: object
  default: []

steps:
- checkout: none
- ${{ if eq(length(parameters.foo), 0) }}:
  - script: echo Foo is empty
    displayName: Foo is empty

Parametre veri türleri

Veri türü	Notlar
`string`	string
`number`	ile kısıtlanabilir `values:`, aksi takdirde sayı benzeri herhangi bir dize kabul edilir
`boolean`	`true` veya `false`
`object`	herhangi bir YAML yapısı
`step`	tek bir adım
`stepList`	adım dizisi
`job`	tek bir iş
`jobList`	iş sırası
`deployment`	tek bir dağıtım işi
`deploymentList`	dağıtım işlerinin sırası
`stage`	tek aşama
`stageList`	aşama dizisi

Step, stepList, job, jobList, deployment, deploymentList, stage ve stageList veri türlerinin tümü standart YAML şema biçimini kullanır. Bu örnek dize, sayı, boole, nesne, adım ve stepList'i içerir.

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