Şablon parametreleri

Parametreleri ve bunların veri türlerini bir şablonda belirtebilir ve bu parametrelere işlem hattında başvurabilirsiniz. templateContext ile, özellikleri şablonda parametre olarak kullanılan aşamalara, adımlara ve işlere de geçirebilirsiniz.

Parametreleri şablonların dışında da kullanabilirsiniz. Değişmez değerleri yalnızca parametre varsayılan değerleri için kullanabilirsiniz. YAML şemasında parametreler hakkında daha fazla bilgi edinin.

Parametreleri geçirme

Parametreler bir ad ve veri türü içermelidir. içinde azure-pipelines.ymlparametresi yesNo boole değerine ayarlandığında derleme başarılı olur. yesNo gibi applesbir dizeye ayarlandığında derleme başarısız olur.

# File: simple-param.yml
parameters:
- name: yesNo # name of the parameter; required
  type: boolean # data type of the parameter; required
  default: false

steps:
- script: echo ${{ parameters.yesNo }}

# File: azure-pipelines.yml
trigger:
- main

extends:
  template: simple-param.yml
  parameters:
      yesNo: false # set to a non-boolean value to have the build fail

Özellikleri şablonlara geçirmek için templateContext kullanma

Şablonda parametre olarak kullanılan aşamalara, adımlara ve işlere daha fazla özellik geçirmek için kullanabilirsiniz templateContext . Özellikle, , deploymentListveya stageList parametre veri türü içinde jobListbelirtebilirsiniztemplateContext.

Her işi işlerken ortamları ayarlamayı kolaylaştırmak için kullanabilirsiniz templateContext . Bir işi ve ortam özellikleri nesnesini birlikte birleştirerek, templateContext YAML'yi daha sürdürülebilir ve daha kolay anlamanıza yardımcı olabilir.

Bu örnekte parametresi testSet testing-template.yml veri türüne jobListsahiptir. Şablontesting-template.yml, her anahtar sözcüğü kullanarak yeni bir değişken testJob oluşturur. Ardından şablon, içinde ayarlanıp azure-pipeline.yml şablona geçirilen öğesine başvururtestJob.templateContext.expectedHTTPResponseCode.

Yanıt kodu 200 olduğunda şablon bir REST isteğinde bulunur. Yanıt kodu 500 olduğunda, şablon hata ayıklama için tüm ortam değişkenlerini oluşturur.

templateContext özellikleri içerebilir.

#testing-template.yml

parameters: 
- name: testSet
  type: jobList

jobs:
- ${{ each testJob in parameters.testSet }}:  # Iterate over each job in the 'testSet' parameter
  - ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 200) }}: # Check if the HTTP response is 200
    - job:
      steps: 
      - powershell: 'Invoke-RestMethod -Uri https://blogs.msdn.microsoft.com/powershell/feed/ | Format-Table -Property Title, pubDate'
      - ${{ testJob.steps }}    
  - ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 500) }}: # Check if the HTTP response is 500
    - job:
      steps:
      - powershell: 'Get-ChildItem -Path Env:\' # Run a PowerShell script to list environment variables
      - ${{ testJob.steps }} # Include additional steps from the 'testJob' object

#azure-pipeline.yml

trigger: none

pool:
  vmImage: ubuntu-latest

extends:
  template: testing-template.yml 
  parameters:
    testSet:  # Define the 'testSet' parameter to pass to the template
    - job: positive_test # Define a job named 'positive_test'
      templateContext:
        expectedHTTPResponseCode: 200 # Set the expected HTTP response code to 200 for this job
      steps:
      - script: echo "Run positive test" 
    - job: negative_test # Define a job named 'negative_test'
      templateContext:
        expectedHTTPResponseCode: 500 # Set the expected HTTP response code to 500 for this job
      steps:
      - script: echo "Run negative test" 

Çalışma zamanında şablon seçme parametreleri

Bir koşula bağlı olarak işlem hattı YAML'sinden farklı şablonlar çağırabilirsiniz. Bu örnekte, experimental.yml parametre experimentalTemplate true olduğunda YAML çalıştırılır.

#azure-pipeline.yml
parameters:
- name: experimentalTemplate 
  displayName: 'Use experimental build process?'
  type: boolean
  default: false

steps:
- ${{ if eq(parameters.experimentalTemplate, true) }}: # Check if 'experimentalTemplate' is true
  - template: experimental.yml
- ${{ if not(eq(parameters.experimentalTemplate, true)) }}:  # Check if 'experimentalTemplate' is not true
  - template: stable.yml

Parametre veri türleri

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  # Define a parameter named 'myString'
  type: string  # The parameter type is string
  default: a string  # Default value is 'a string'

- name: myMultiString  # Define a parameter named 'myMultiString'
  type: string  # The parameter type is string
  default: default  # Default value is 'default'
  values:  # Allowed values for 'myMultiString'
  - default  
  - ubuntu  

- name: myNumber  # Define a parameter named 'myNumber'
  type: number  # The parameter type is number
  default: 2  # Default value is 2
  values:  # Allowed values for 'myNumber'
  - 1  
  - 2  
  - 4  
  - 8  
  - 16  

- name: myBoolean  # Define a parameter named 'myBoolean'
  type: boolean  # The parameter type is boolean
  default: true  # Default value is true

- name: myObject  # Define a parameter named 'myObject'
  type: object  # The parameter type is object
  default:  # Default value is an object with nested properties
    foo: FOO  # Property 'foo' with value 'FOO'
    bar: BAR  # Property 'bar' with value 'BAR'
    things:  # Property 'things' is a list
    - one  
    - two  
    - three  
    nested:  # Property 'nested' is an object
      one: apple  # Property 'one' with value 'apple'
      two: pear  # Property 'two' with value 'pear'
      count: 3  # Property 'count' with value 3

- name: myStep  # Define a parameter named 'myStep'
  type: step  # The parameter type is step
  default:  # Default value is a step
    script: echo my step 

- name: mySteplist  # Define a parameter named 'mySteplist'
  type: stepList  # The parameter type is stepList
  default:  # Default value is a list of steps
    - script: echo step one  
    - script: echo step two  

trigger: none  

jobs: 
- job: stepList  # Define a job named 'stepList'
  steps: ${{ parameters.mySteplist }}  # Use the steps from the 'mySteplist' parameter

- job: myStep  # Define a job named 'myStep'
  steps:
    - ${{ parameters.myStep }}  # Use the step from the 'myStep' parameter

Bir nesnede yineleme yapabilir ve nesnedeki her dizeyi yazdırabilirsiniz.

parameters:
- name: listOfStrings  
  type: object
  default: 
  - one
  - two

steps:
- ${{ each value in parameters.listOfStrings }}: # Iterate over each value in the 'listOfStrings' parameter
  - script: echo ${{ value }} # Output the current value in the iteration

Ayrıca, bir nesnenin içindeki iç içe öğeler arasında yineleme yapabilirsiniz.

parameters:
- name: listOfFruits
  type: object
  default:
  - fruitName: 'apple'
    colors: ['red','green']
  - fruitName: 'lemon'
    colors: ['yellow'] 

steps:
- ${{ each fruit in parameters.listOfFruits }} : # Iterate over each fruit in the 'listOfFruits'
  - ${{ each fruitColor in fruit.colors}} : # Iterate over each color in the current fruit's colors
    - script: echo ${{ fruit.fruitName}} ${{ fruitColor }} # Echo the current fruit's name and color

Ayrıca bir nesnenin anahtarlarına ve karşılık gelen değerlere doğrudan başvurabilirsiniz.

parameters:
  - name: myObject
    type: object
    default:
      key1: 'value1'
      key2: 'value2'
      key3: 'value3'

jobs:
- job: ExampleJob
  displayName: 'Example object parameter job'
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - script: |
      echo "Keys in myObject:"
      echo "Key1: ${{ parameters.myObject.key1 }}"
      echo "Key2: ${{ parameters.myObject.key2 }}"
      echo "Key3: ${{ parameters.myObject.key3 }}"
    displayName: 'Display object keys and values'

Gerekli parametreler

İstediğiniz parametreleri denetlemek için şablonunuzun başına bir doğrulama adımı ekleyebilirsiniz.

Bash kullanarak parametreyi denetleen bir örnek aşağıda verilmişti solution :

# File: steps/msbuild.yml

parameters:
- name: 'solution'
  default: ''
  type: string

steps:
- bash: |
    if [ -z "$SOLUTION" ]; then
      echo "##vso[task.logissue type=error;]Missing template parameter \"solution\""
      echo "##vso[task.complete result=Failed;]"
    fi
  env:
    SOLUTION: ${{ parameters.solution }}
  displayName: Check for required parameters
- task: msbuild@1
  inputs:
    solution: ${{ parameters.solution }}
- task: vstest@2
  inputs:
    solution: ${{ parameters.solution }}

Gerekli parametre eksikse şablonun başarısız olduğunu göstermek için:

# File: azure-pipelines.yml

# This will fail since it doesn't set the "solution" parameter to anything,
# so the template will use its default of an empty string
steps:
- template: steps/msbuild.yml

Parametreleri şablonlara geçirebilirsiniz. parameters bölümü, şablonda hangi parametrelerin kullanılabilir olduğunu ve bunların varsayılan değerlerini tanımlar. Şablonlar, işlem hattı çalışmadan hemen önce genişletilir, böylece ile ${{ }} çevrelenen değerler, kapsayan işlem hattından aldığı parametrelerle değiştirilir. Sonuç olarak, parametrelerde yalnızca önceden tanımlanmış değişkenler kullanılabilir.

Parametreleri birden çok işlem hattında kullanmak için bkz. Değişken grubu oluşturma.

Parametrelerle iş, aşama ve adım şablonları

# File: templates/npm-with-params.yml

parameters:
  name: ''  # defaults for any parameters that aren't specified
  vmImage: ''

jobs:
- job: ${{ parameters.name }}
  pool: 
    vmImage: ${{ parameters.vmImage }}
  steps:
  - script: npm install
  - script: npm test

şablonu işlem hattınızda kullandığınızda, şablon parametreleri için değerleri belirtin.

# File: azure-pipelines.yml

jobs:
- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: Linux
    vmImage: 'ubuntu-latest'

- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: macOS
    vmImage: 'macOS-10.13'

- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: Windows
    vmImage: 'windows-latest'

Parametreleri adım veya aşama şablonlarıyla da kullanabilirsiniz. Örneğin, parametreleri olan adımlar:

# File: templates/steps-with-params.yml

parameters:
  runExtendedTests: 'false'  # defaults for any parameters that aren't specified

steps:
- script: npm test
- ${{ if eq(parameters.runExtendedTests, 'true') }}:
  - script: npm test --extended

şablonu işlem hattınızda kullandığınızda, şablon parametreleri için değerleri belirtin.

# File: azure-pipelines.yml

steps:
- script: npm install

- template: templates/steps-with-params.yml  # Template reference
  parameters:
    runExtendedTests: 'true'

Parametreler skaler dizelerle sınırlı değildir. Parametresinin genişletildiği yer bir eşleme beklediği sürece, parametre bir eşleme olabilir. Benzer şekilde, dizilerin beklendiği yerde diziler geçirilebilir. Örnek:

# azure-pipelines.yml
jobs:
- template: process.yml
  parameters:
    pool:   # this parameter is called `pool`
      vmImage: ubuntu-latest  # and it's a mapping rather than a string


# process.yml
parameters:
  pool: {}

jobs:
- job: build
  pool: ${{ parameters.pool }}