Ş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. Sabit 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. Eğer azure-pipelines.yml içinde, parametre yesNo bir boole değerine ayarlanırsa derleme başarılı olur. gibi yesNobir dizeye ayarlanırsa apples 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 templateContext, adımlara ve işlere daha fazla özellik geçirmek için kullanabilirsiniz. Özellikle, templateContext, jobList veya deploymentList parametre veri türü içinde belirtilen stageList'yi kullanabilirsiniz.

templateContext her işi işlerken ortamları ayarlamayı kolaylaştırır. Bir işi ve ortam özellikleri nesnesini birlikte birleştirerek, templateContext daha sürdürülebilir ve anlaşılması kolay YAML oluşturmanıza yardımcı olur.

Bu örnekte, testSet içindeki testing-template.yml parametresinin veri türü jobList'dir. Şablontesting-template.yml, her anahtar sözcüğütestJobyeni bir değişken oluşturur. Ardından şablon, `testJob.templateContext.expectedHTTPResponseCode` içinde ayarlanan ve şablona geçirilen `azure-pipeline.yml` öğesine başvurur.

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

Veri türü	Notlar
`string`	Dize
`stringList`	Bir öğe listesi, birden fazla seçilebilir. Şablonlarda kullanılamaz
`number`	ile sınırlandırılmış `values:`olabilir, 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 bir aşama
`stageList`	aşama dizisi

step, , stepList, job, jobList, , deployment, deploymentListstagestringListve stageList veri türlerinin tümü standart YAML şema biçimini kullanır. Bu örnek string, number, boolean, object, step ve stepList içerir.

Uyarı

Veri stringList türü şablonlarda kullanılamaz. object Bunun yerine şablonlarda veri türünü kullanın.

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', only one default
  values:  # Allowed values for 'myMultiString'
  - default  
  - ubuntu  

- name: myStringlist # Define a parameter named 'myStringlist'
  type: stringList # The parameter type is stringList
  displayName: Regions
  values: # Allowed values for 'myStringlist'
    - WUS
    - CUS
    - EUS
  default: # Default values
    - WUS
    - CUS
    
- 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

- job: stringList  # Define a job named 'stringList'
  steps:
  - ${{ each region in parameters.myStringlist }}:
      - script: echo ${{region}}

Parametreler ve bunların veri türleri arasında yineleme

Azure Pipelines dizeler, nesneler, sayılar ve boole'lar gibi çeşitli veri türlerinin parametrelerinde yineleme yapmanızı sağlar. Bu esneklik, parametre değerlerine göre dinamik işlem hattı davranışını etkinleştirir. Parametreler arasında yineleme yapmayı ve farklı veri türlerini işlemeyi gösteren örnekler aşağıda verilmiştir.

Basit parametreler aracılığıyla yineleme

Basit parametreler olan dizeler, sayılar ve boole'lar üzerinde döngü oluşturabilirsiniz. Bu örnekte işlem hattı bir parametre listesi üzerinden yinelenir ve adlarını ve değerlerini yazdırır.

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

Nesneler arasında yineleme yapma

Nesneler, iç içe öğeler gibi karmaşık parametre yapıları tanımlamanızı sağlar. Anahtarlarına ve değerlerine veya iç içe geçmiş özelliklerine erişmek için nesneler arasında yineleme yapabilirsiniz.

Örnek: Nesne anahtarları ve değerleri arasında yineleme

Aşağıdaki şablon dosyası, parametresini myObject varsayılan anahtar-değer çiftlerine sahip bir nesne olarak tanımlar. İş, anahtarlar üzerinde döngüye girer ve değerlerini yazdırır.

# object-keys-template.yml

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'

İşlem hattı, varsayılan değerleri myObject ile özel değerlerle geçersiz kılar.

# azure-pipelines.yml

trigger:
- main

extends:
  template: object-keys-template.yml
  parameters:
    myObject:
      key1: 'customValue1'
      key2: 'customValue2'
      key3: 'customValue3'

Örnek: İç içe nesneler arasında yineleme

Şablon, iç içe dizileri olan nesneleri içeren bir listOfFruits parametre tanımlar, ardından her meyveyi ve ilişkili renklerini işlemek için iç içe döngüleri kullanır.

# File: nested-objects-template.yml

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

İşlem hattı dosyası, özel meyve verileriyle varsayılan değerlerin nasıl geçersiz kılınacaklarını gösterir.

# File: azure-pipelines.yml

trigger:
- main

extends:
  template: nested-objects-template.yml
  parameters:
    listOfFruits:
    - fruitName: 'banana'
      colors: ['yellow']
    - fruitName: 'grape'
      colors: ['purple', 'green']

stepList parametresiyle adımların listesini dinamik olarak ekleyin

Bu örnekte parametre türü, stepList derleme işlemindeki adımların listesini dinamik olarak eklemek için kullanılır.

Ana işlem hattı (azure-pipelines.yml) iki görevi tanımlar: oluşturma ve dağıtma.
Derleme işi bir şablon (build.yml) kullanır ve stepList parametresini kullanarak derleme görevlerinin bir listesini geçirir.
Şablon, build.yml parametresinde build_tasks tanımlanan adımları dinamik olarak içerir.

#azure-pipelines.yml

trigger:
- main

jobs:
  - job: build
    displayName: 'Build .NET Core Application'
    pool:
      vmImage: 'ubuntu-latest'

    steps:
      - checkout: self

      - template: build.yml
        parameters:
          build_tasks:
            - task: DotNetCoreCLI@2
              displayName: 'Restore'
              inputs:
                command: 'restore'
                projects: '**/*.csproj'  

            - task: DotNetCoreCLI@2
              displayName: 'Build'
              inputs:
                command: 'build'
                arguments: '--no-restore'
                projects: '**/*.csproj' 

  - job: deploy
    displayName: 'Pack for Azure App Service deployment'
    dependsOn: build
    pool:
      vmImage: 'ubuntu-latest'
    steps:
      - download: current
        artifact: drop

Şablon build.yml :

stepList türü ve varsayılan boş liste ile parametresini build_tasks tanımlar.
.NET Core SDK'sını 8.x olarak ayarlar.
build_tasks parametresindeki her bir adım üzerinde yineleme yapılır.
Listede tanımlanan her adımı yürütür build_tasks .

#build.yml

parameters:
  - name: build_tasks
    type: stepList
    default: []

steps:
  - task: UseDotNet@2
    displayName: 'Use .NET Core SDK'
    inputs:
      packageType: 'sdk'
      version: '8.x'

  - ${{ each step in parameters.build_tasks }}:
      - ${{ step }}

  - task: DotNetCoreCLI@2
    displayName: 'Publish'
    inputs:
      command: 'publish'
      arguments: '--configuration Release --output $(Build.ArtifactStagingDirectory)'
      projects: '**/*.csproj'

  - task: PublishBuildArtifacts@1
    displayName: 'Publish Artifact'
    inputs:
      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
      ArtifactName: 'drop'

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2025-12-17