Futtatókörnyezeti paraméterek

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

A futtatókörnyezeti paraméterek nagyobb mértékben szabályozják a folyamatnak átadott értékeket. Futtatókörnyezeti paraméterekkel a következőt teheti:

• 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ése során érhetők el. A folyamat futtatása előtt kibővülnek, és a paraméterértékekkel körülvett ${{ }} értékeket cserélik le. Használjon változókat, ha az értékeknek elérhetőnek kell lenniük a folyamatfuttatás során.

Megjegyzés

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

A paramétereknek nevet és adattípust kell tartalmazniuk. A paraméterek megadása nem kötelező. A YAML-fájlban vagy a folyamat futtatásakor alapértelmezett értéket kell hozzárendelnie. Ha nem rendel hozzá alapértelmezett értéket, vagy nem állítja be a default értéket a false értékre, akkor az 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.

Mi a különbség a paraméterek és a változók között?

Az alábbi táblázat az Azure Pipelines paraméterei és változói közötti főbb különbségeket emeli ki.

Tulajdonság	Paraméterek	Változók
Kiértékelési idő	Sablon elemzése (várakozási sor)	A kiértékelés szintaxisfüggő. A makrószintaxissal ($(var)) definiált változók futásidőben kiértékelik a feladatokat, és szkriptekben és feladatokban használják. A futtatókörnyezeti kifejezésekkel ($[variables.var]) definiált változók kiértékelése egy feladat vagy szakasz futtatása előtt történik, és feltételekben vagy dinamikus változók hozzárendelésében használatosak.
Módosíthatóság	Sorbanállás után nem módosítható	A felhasználó által definiált, környezeti és kimeneti változók dinamikusan frissíthetők a folyamat végrehajtása során
Felhasználói felület megjelenítése futás közben	A Futtatási folyamat felhasználói felületén látható, és futtatás előtt is beállítható	Futtatás közben láthatóvá válik, ha a Pipeline UI-ban felülírhatóként van beállítva
Titkos kódok értékei	A titkos értékek támogatása nem elérhető	Titkos kulcsként is beállítható

Paraméterek használata adatfolyamokban

Állítsa be a futtatókörnyezet paramétereit egy YAML-fájl elején.

Ez a példafolyamat egy image paramétert tartalmaz, amely három üzemeltetett ügynököt kínál string opcióként. 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ása "nincs", így kiválaszthatja a image értékét, amikor manuálisan aktiválja a csővezetéket 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 folyamatfuttatási lapon válassza a Folyamat futtatása lehetőséget a folyamat futtatásához. Megjelenik az opció a Pool képének kiválasztására. Ha nem ad meg kijelölést, a rendszer az alapértelmezett beállítást ubuntu-latest használja. Nem választhat készletképet, ha a folyamatot a YAML-szerkesztőből futtatja.

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, amely azt szabályozza, testhogy a folyamat tesztjeit futtatja-e. Ha a test értéke igaz, akkor a lépés lefut, amely az összes teszt futtatását végzi.

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 a x86 és a x64 architektúrák is felépítődnek.

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

Szelektíven kizár egy szakaszt

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 a négy szakaszból csak három fut, hacsak nem frissíti az értéket.

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

Üres paraméterobjektum keresése

A length() ellenőrizheti, hogy egy objektumparaméter nem rendelkezik-e értékkel.

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

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

Paraméter adattípusai

Adattípus	Jegyzetek
string	karakterlánc
stringList	elemek listája, több is kijelölhető. Nem érhető el a sablonokban
number	Lehet, hogy korlátozott lesz values:, különben bármilyen számhoz hasonló karakterlánc elfogadott.
boolean	true vagy false
object	bármilyen YAML-struktúra
step	egyetlen lépés
stepList	lépések sorozata
job	egyetlen feladat
jobList	munkasorozat
deployment	egyetlen üzembehelyezési feladat
deploymentList	üzembehelyezési feladatok sorozata
stage	egyetlen szakasz
stageList	szakaszok sorozata

A step, stepList, job, jobList, deploymentdeploymentList, , stagestringListés stageList adattípusok mind szabványos YAML-sémaformátumot használnak. Ez a példa tartalmazza string, number, boolean, object, step, és stepList.

Megjegyzés

Az stringList adattípus nem érhető el a sablonokban. Használja inkább az object adattípust a sablonokban.

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

Ajánlott paraméterbiztonsági eljárások

Ha futtatókörnyezeti paramétereket használ az Azure Pipelinesban, ne adjon át titkos kulcsokat vagy bizalmas értékeket paraméterbemenetként. A paraméterértékek a sablonelemzési időpontban bővülnek, és megjelenhetnek a folyamatnaplókban vagy kimenetekben.

Mindig ellenőrizze és korlátozza az engedélyezett paraméterértékeket a váratlan vagy nem biztonságos bemenetek injektálásának megakadályozása érdekében. A folyamaterőforrásokhoz való hozzáférés biztosításakor kövesse a minimális jogosultság elvét.

Hitelesítő adatok, jogkivonatok vagy egyéb bizalmas adatok esetén használjon titkos kódként megjelölt és az Azure Key Vaultban, a folyamat felhasználói felületén vagy változócsoportokban tárolt folyamatváltozókat. További információ: Titkos kódok védelme az Azure Pipelinesban.