Parametri del modello
È possibile specificare i parametri e i relativi tipi di dati in un modello e fare riferimento a tali parametri in una pipeline. Con templateContext è anche possibile passare proprietà a fasi, passaggi e processi usati come parametri in un modello.
È anche possibile usare parametri esterni ai modelli. È possibile usare valori letterali solo per i valori predefiniti dei parametri. Altre informazioni sui parametri nello schema YAML.
Passaggio dei parametri
I parametri devono contenere un nome e un tipo di dati. In azure-pipelines.yml
, quando il parametro yesNo
è impostato su un valore booleano, la compilazione ha esito positivo. Quando yesNo
è impostato su una stringa, apples
ad esempio , la compilazione ha esito negativo.
# 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
Usare templateContext per passare le proprietà ai modelli
È possibile usare templateContext
per passare più proprietà a fasi, passaggi e processi usati come parametri in un modello. In particolare, è possibile specificare templateContext
all'interno del jobList
tipo di dati del parametro , deploymentList
o stageList
.
È possibile usare templateContext
per semplificare la configurazione degli ambienti durante l'elaborazione di ogni processo. Raggruppando un processo e l'oggetto proprietà dell'ambiente, templateContext
è possibile ottenere informazioni più gestibili e più facili da comprendere in YAML.
In questo esempio il parametro testSet
in testing-template.yml
ha il tipo di jobList
dati . Il modello testing-template.yml
crea una nuova variabile testJob
usando la parola chiave each. Il modello fa quindi riferimento a testJob.templateContext.expectedHTTPResponseCode
, che viene impostato in azure-pipeline.yml
e passato al modello.
Quando il codice di risposta è 200, il modello effettua una richiesta REST. Quando il codice di risposta è 500, il modello restituisce tutte le variabili di ambiente per il debug.
templateContext
può contenere proprietà.
#testing-template.yml
parameters:
- name: testSet
type: jobList
jobs:
- ${{ each testJob in parameters.testSet }}:
- ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 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) }}:
- job:
steps:
- powershell: 'Get-ChildItem -Path Env:\'
- ${{ testJob.steps }}
#azure-pipeline.yml
trigger: none
pool:
vmImage: ubuntu-latest
extends:
template: testing-template.yml
parameters:
testSet:
- job: positive_test
templateContext:
expectedHTTPResponseCode: 200
steps:
- script: echo "Run positive test"
- job: negative_test
templateContext:
expectedHTTPResponseCode: 500
steps:
- script: echo "Run negative test"
Parametri per selezionare un modello in fase di esecuzione
È possibile chiamare modelli diversi da un YAML della pipeline a seconda di una condizione. In questo esempio, YAML experimental.yml
viene eseguito quando il parametro experimentalTemplate
è true.
#azure-pipeline.yml
parameters:
- name: experimentalTemplate
displayName: 'Use experimental build process?'
type: boolean
default: false
steps:
- ${{ if eq(parameters.experimentalTemplate, true) }}:
- template: experimental.yml
- ${{ if not(eq(parameters.experimentalTemplate, true)) }}:
- template: stable.yml
Tipi di dati dei parametri
Tipo di dati | Note |
---|---|
string |
string |
number |
può essere limitato a . In caso contrario, viene accettata qualsiasi stringa simile a values: un numero |
boolean |
true oppure false |
object |
qualsiasi struttura YAML |
step |
un singolo passaggio |
stepList |
sequenza di passaggi |
job |
un singolo processo |
jobList |
sequenza di processi |
deployment |
un singolo processo di distribuzione |
deploymentList |
sequenza di processi di distribuzione |
stage |
una singola fase |
stageList |
sequenza di fasi |
I tipi di dati step, stepList, jobList, deployment, deploymentList, stage e stageList usano tutti il formato di schema YAML standard. Questo esempio include string, number, boolean, object, step e stepList.
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 }}
È possibile scorrere un oggetto e stampare ogni stringa nell'oggetto .
parameters:
- name: listOfStrings
type: object
default:
- one
- two
steps:
- ${{ each value in parameters.listOfStrings }}:
- script: echo ${{ value }}
Inoltre, è possibile scorrere gli elementi annidati all'interno di un oggetto .
parameters:
- name: listOfFruits
type: object
default:
- fruitName: 'apple'
colors: ['red','green']
- fruitName: 'lemon'
colors: ['yellow']
steps:
- ${{ each fruit in parameters.listOfFruits }} :
- ${{ each fruitColor in fruit.colors}} :
- script: echo ${{ fruit.fruitName}} ${{ fruitColor }}
Parametri obbligatori
È possibile aggiungere un passaggio di convalida all'inizio del modello per verificare la presenza dei parametri necessari.
Di seguito è riportato un esempio che verifica la presenza del solution
parametro usando Bash (che consente il funzionamento su qualsiasi piattaforma):
# 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 }}
Per indicare che il modello ha esito negativo se manca il parametro obbligatorio:
# 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
È possibile passare parametri ai modelli.
La parameters
sezione definisce i parametri disponibili nel modello e i relativi valori predefiniti.
I modelli vengono espansi poco prima dell'esecuzione della pipeline in modo che i valori racchiusi tra ${{ }}
di loro vengano sostituiti dai parametri ricevuti dalla pipeline di inclusione. Di conseguenza, solo le variabili predefinite possono essere usate nei parametri.
Per usare i parametri tra più pipeline, vedere come creare un gruppo di variabili.
Modelli di processo, fase e passaggio con parametri
# 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
Quando si utilizza il modello nella pipeline, specificare i valori per i parametri del modello.
# 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'
È anche possibile usare i parametri con modelli di passaggio o di fase. Ad esempio, passaggi con parametri:
# 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
Quando si utilizza il modello nella pipeline, specificare i valori per i parametri del modello.
# File: azure-pipelines.yml
steps:
- script: npm install
- template: templates/steps-with-params.yml # Template reference
parameters:
runExtendedTests: 'true'
Nota
I parametri scalari vengono sempre considerati come stringhe.
Ad esempio, eq(parameters['myparam'], true)
restituirà true
quasi sempre , anche se il myparam
parametro è la parola false
.
Le stringhe non vuote vengono cast in true
in un contesto booleano.
Tale espressione può essere riscritta per confrontare in modo esplicito le stringhe: eq(parameters['myparam'], 'true')
.
I parametri non sono limitati alle stringhe scalari. Se la posizione in cui il parametro si espande prevede un mapping, il parametro può essere un mapping. Analogamente, è possibile passare sequenze in cui sono previste sequenze. Ad esempio:
# 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 }}