Futtatókörnyezeti paraméterek

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

A futtatókörnyezeti paraméterekkel jobban szabályozhatja, hogy milyen értékeket lehet átadni egy folyamatnak. Futtatókörnyezeti paraméterekkel:

• Különböző értékek biztosítása szkriptekhez és feladatokhoz futásidőben
• Paramétertípusok, engedélyezett tartományok és alapértelmezett értékek szabályozása
• Feladatok és szakaszok dinamikus kiválasztása sablonkifejezésekkel

A paramétereket a sablonokban és a folyamatban is megadhatja. A paraméterek olyan adattípusokkal rendelkeznek, mint a szám és a sztring, és az értékek egy részhalmazára korlátozhatók. A parameters YAML szakasza határozza meg, hogy mely paraméterek érhetők el.

A paraméterek csak a sablon elemzésekor érhetők el. A paramétereket a folyamat futtatása előtt bontja ki a rendszer, hogy a körülvett ${{ }} értékeket paraméterértékek válthassák fel. Használjon változókat , ha azt szeretné, hogy az értékek szélesebb körben elérhetők legyenek a folyamat futtatása során.

Feljegyzés

Ez az útmutató nem vonatkozik a klasszikus folyamatokra. A klasszikus folyamatok paramétereit lásd: Folyamatparaméterek (klasszikus).

A paramétereknek nevet és adattípust kell tartalmazniuk. A paraméterek nem választhatók. A YAML-fájlban vagy a folyamat futtatásakor egy alapértelmezett értéket kell hozzárendelni. Ha nem rendel hozzá alapértelmezett értéket, vagy nem állítja be default , falseaz első elérhető érték lesz használva.

A templateContext használatával további tulajdonságokat adhat át a sablonban paraméterekként használt szakaszoknak, lépéseknek és feladatoknak.

Paraméterek használata folyamatokban

Állítsa be a futásidejű paramétereket a YAML elején.

Ez a példafolyamat tartalmaz egy paramétert image , amely három üzemeltetett ügynököt tartalmaz beállításként string . A feladatok szakaszban az pool érték a feladat futtatásához használt paraméter ügynökét adja meg. A trigger beállítás értéke nincs, így kiválaszthatja image annak az értékét, amikor manuálisan aktiválja a folyamatot a futtatáshoz.

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

A folyamat futtatásakor válassza ki a készlet lemezképét. Ha nem ad meg kijelölést, a rendszer az alapértelmezett beállítást ubuntu-latest használja.

Feltételes feltételek használata paraméterekkel

Paramétereket a feltételes logika részeként is használhat. Feltételes feltételek esetén a YAML egy része akkor fut, ha megfelel a if feltételeknek.

Paraméterek használata a futtatás lépéseinek meghatározásához

Ez a folyamat hozzáad egy második logikai paramétert, amellyel szabályozható, testhogy futtat-e teszteket a folyamatban. Ha az érték test igaz, az a lépés, amely az összes teszt futtatását adja ki.

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"

Paraméterek használata a használt konfiguráció beállításához

Paraméterekkel is beállíthatja, hogy mely feladatok fussanak. Ebben a példában különböző architektúrák épülnek fel a paraméter értékétől config függően, ami egy string típus. Alapértelmezés szerint az architektúrák és x64 az x86 architektúrák is létrejönnek.

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

Szakasz szelektív kizárása

Paraméterekkel azt is beállíthatja, hogy egy szakasz fut-e. Ebben a példában egy folyamat négy fázisból és különböző feladatokból áll az egyes szakaszokhoz. A Teljesítményteszt szakasz akkor fut, ha a paraméter runPerfTests igaz. Az alapértelmezett érték runPerfTests hamis, ezért frissítések nélkül a négy fázisból csak három fut.

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

Paraméterek ciklusos léptetése

A sztringen, a számon és a logikai paramétereken is végighaladhat.

Szkript

Ebben a példában végighalad a paramétereken, és kinyomtatja az egyes paraméterek nevét és értékét. Négy különböző paraméter létezik, és mindegyik más típust jelöl. myStringName egy egysoros sztring. myMultiString egy többsoros sztring. myNumber egy szám. myBoolean logikai érték. A lépések szakaszban a szkriptfeladatok az egyes paraméterek kulcsát és értékét jelenítik meg.

# 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

PowerShell

Ebben a példában végighalad a paramétereken, és kinyomtatja az egyes paraméterek nevét és értékét. Négy különböző paraméter létezik, és mindegyik más típust jelöl. myStringName egy egysoros sztring. myMultiString egy többsoros sztring. myNumber egy szám. myBoolean logikai érték. A lépések szakaszban végigfuttathatja egy PowerShell-feladat paramétereit, és környezeti változóként állíthatja be az egyes paramétereket.

# 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

Üres paraméterobjektum keresése

A kifejezéssel length() ellenőrizheti, hogy egy objektumparaméternek nincs-e értéke.

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

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

Lépéslista dinamikus belefoglalása a stepList paraméterrel

Ebben a példában a stepList paramétertípussal dinamikusan szerepel a buildelési folyamat lépéseinek listája.

• A fő folyamat (azure-pipelines.yml) két feladatot határoz meg: a buildelést és az üzembe helyezést.
• A buildelési feladat egy sablont (build.yml) használ, és átadja a buildelési feladatok listáját a stepList paraméterrel.
• A build.yml sablon dinamikusan tartalmazza a paraméterben build_tasks meghatározott lépéseket.

#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

A build.yml sablon:

• Meghatározza a paramétert build_tasks a stepList típussal és egy alapértelmezett üres listával.
• A .NET Core SDK beállítása 6.x értékre.
• A paraméter minden lépését végigfuttatja build_tasks .
• Végrehajtja a listában definiált build_tasks összes lépést.

#build.yml

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

steps:
  - task: UseDotNet@2
    displayName: 'Use .NET Core SDK'
    inputs:
      packageType: 'sdk'
      version: '6.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'

Paraméter adattípusai

Adattípus	Jegyzetek
string	húr
number	lehet korlátozni, values:különben a számszerű sztringek elfogadottak
boolean	true vagy false
object	bármilyen YAML-struktúra
step	egyetlen lépés
stepList	lépések sorozata
job	egyetlen feladat
jobList	feladatütemezés
deployment	egyetlen üzembehelyezési feladat
deploymentList	üzembehelyezési feladatok sorozata
stage	egyetlen szakasz
stageList	szakaszok sorozata

A stepList, stepList, job, jobList, deployment, deploymentList, stage és stageList adattípusok mind szabványos YAML-sémaformátumot használnak. Ez a példa sztringet, számot, logikai értéket, objektumot, lépést és stepListet tartalmaz.

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