Usare le variabili nelle pipeline di versione classica

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

L'uso delle variabili nelle pipeline di versione classica è un modo pratico per scambiare e trasportare i dati in tutta la pipeline. Ogni variabile viene archiviata come stringa e il relativo valore può cambiare tra le esecuzioni della pipeline.

Quando si configurano attività per distribuire l'applicazione in ogni fase della pipeline di versione classica, le variabili possono essere utili:

• Semplificare la personalizzazione: definire una pipeline di distribuzione generica una sola volta e adattarla facilmente per diverse fasi. Ad esempio, usare una variabile per rappresentare il stringa di connessione di una distribuzione Web, modificandone il valore in base alle esigenze per ogni fase. Queste variabili sono note come variabili personalizzate.

• Sfruttare le informazioni contestuali: accedere ai dettagli sul contesto di rilascio, ad esempio una fase, un artefatto o l'agente che esegue la distribuzione. Ad esempio, gli script potrebbero richiedere il percorso di compilazione per il download o la directory di lavoro dell'agente per creare file temporanei. Queste variabili vengono definite variabili predefinite.

Variabili predefinite

Le variabili predefinite forniscono informazioni essenziali sul contesto di esecuzione per le attività e gli script in esecuzione. Queste variabili consentono di accedere ai dettagli relativi al sistema, alla versione, alla fase o all'agente in cui sono in esecuzione.

Ad eccezione di System.Debug, le variabili predefinite sono di sola lettura, con i relativi valori impostati automaticamente dal sistema.

Alcune delle variabili più significative sono descritte nelle tabelle seguenti. Per visualizzare l'elenco completo, vedere Visualizzare i valori correnti di tutte le variabili.

Variabili di sistema

Variabili di rilascio

Variabili della fase di rilascio

Variabili dell'agente

Variabili release Artifacts

Per ogni artefatto a cui viene fatto riferimento in una versione, è possibile usare le variabili di artefatto seguenti. Si noti che non tutte le variabili si applicano a ogni tipo di artefatto. La tabella seguente elenca le variabili di artefatto predefinite e fornisce esempi dei relativi valori in base al tipo di artefatto. Se un esempio è vuoto, indica che la variabile non è applicabile per tale tipo di artefatto.

Sostituire il {alias} segnaposto con il valore specificato per l'alias di origine dell'artefatto o con il valore predefinito generato per la pipeline di versione.

Variabili dell'artefatto primario

Nelle pipeline di versione classica, se si usano più artefatti, è possibile designarne uno come artefatto primario. Azure Pipelines popola quindi le variabili seguenti per l'artefatto primario designato.

Usare le variabili predefinite

È possibile usare le variabili predefinite in due modi: come parametri per le attività in una pipeline di versione o all'interno degli script.

È possibile usare una variabile predefinita direttamente come input per un'attività. Ad esempio, per passare Release.Artifacts.{Artifact alias}.DefinitionName come argomento a un'attività di PowerShell per un artefatto con ASPNET4.CI come alias, usare $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Per usare una variabile predefinita nello script, è necessario innanzitutto sostituire nei . nomi delle variabili predefinite con _. Ad esempio, per stampare il valore di Release.Artifacts.{Artifact alias}.DefinitionName per un artefatto con ASPNET4.CI come alias in uno script di PowerShell, usare $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. Si noti che l'alias originale, ASPNET4.CI, viene sostituito con ASPNET4_CI.

Variabili personalizzate

Le variabili personalizzate possono essere definite in vari ambiti.

• Gruppi di variabili: usare gruppi di variabili per condividere valori tra tutte le definizioni in un progetto. Ciò è utile quando si vogliono usare gli stessi valori in definizioni, fasi e attività all'interno di un progetto e gestirli da un'unica posizione. Definire e gestire gruppi di variabili nella libreria Pipelines>.

• Variabili della pipeline di versione: usare le variabili della pipeline di versione per condividere i valori in tutte le fasi all'interno di una pipeline di versione. Questo è ideale per gli scenari in cui è necessario un valore coerente tra le fasi e le attività, con la possibilità di aggiornarlo da una singola posizione. Definire e gestire queste variabili nella scheda Variabili della pipeline di versione. Nella pagina Variabili pipeline impostare l'elenco a discesa Ambito su Rilascio quando si aggiunge una variabile.

• Variabili di fase: usare le variabili di fase per condividere i valori all'interno di una fase specifica di una pipeline di versione. Ciò è utile per i valori che differiscono dalla fase alla fase, ma sono coerenti in tutte le attività all'interno di una fase. Definire e gestire queste variabili nella scheda Variabili della pipeline di versione. Nella pagina Variabili pipeline impostare l'elenco a discesa Ambito sull'ambiente appropriato quando si aggiunge una variabile.

L'uso di variabili personalizzate a livello di progetto, pipeline di versione e fase consente di:

• Evitare di duplicare i valori, semplificando l'aggiornamento di tutte le occorrenze con una singola modifica.

• Proteggere i valori sensibili impedendo loro di essere visualizzati o modificati dagli utenti. Per contrassegnare una variabile come sicura (segreto), selezionare l'icona accanto alla variabile.

  Importante

  I valori delle variabili nascoste (segreto) vengono archiviati in modo sicuro nel server e non possono essere visualizzati dagli utenti dopo il salvataggio. Durante la distribuzione, Azure Pipelines decrittografa questi valori quando si fa riferimento alle attività e li passa all'agente tramite un canale HTTPS sicuro.

Usare variabili personalizzate

Per usare variabili personalizzate nelle attività, racchiudere il nome della variabile tra parentesi e precederlo con un $ carattere. Ad esempio, se si dispone di una variabile denominata adminUserName, è possibile inserire il relativo valore corrente in un'attività come $(adminUserName).

Definire e modificare le variabili in uno script

Per definire o modificare una variabile da uno script, usare il task.setvariable comando di registrazione. Il valore della variabile aggiornato ha come ambito il processo in esecuzione e non viene mantenuto tra processi o fasi. Si noti che i nomi delle variabili vengono trasformati in lettere maiuscole, con "." e " " sostituiti con "_".

Ad esempio, Agent.WorkFolder diventa AGENT_WORKFOLDER.

• In Windows accedere a questa variabile come %AGENT_WORKFOLDER% o $env:AGENT_WORKFOLDER.
• In Linux e macOS usare $AGENT_WORKFOLDER.

@echo ##vso[task.setvariable variable=sauce]crushed tomatoes
@echo ##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic

"$(sauce)" "$(secret.Sauce)"

@echo off
set sauceArgument=%~1
set secretSauceArgument=%~2
@echo No problem reading %sauceArgument% or %SAUCE%
@echo But I cannot read %SECRET_SAUCE%
@echo But I can read %secretSauceArgument% (but the log is redacted so I do not spoil the secret)

Write-Host "##vso[task.setvariable variable=sauce]crushed tomatoes"
Write-Host "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with
            garlic"

-sauceArgument "$(sauce)" -secretSauceArgument "$(secret.Sauce)"

Param(
   [string]$sauceArgument,
   [string]$secretSauceArgument
)
Write-Host No problem reading $env:SAUCE or $sauceArgument
Write-Host But I cannot read $env:SECRET_SAUCE
Write-Host But I can read $secretSauceArgument "(but the log is redacted so I do not spoil the secret)"

- pwsh: |
      Write-Host No problem reading $(sauce)
      Write-Host But I cannot read $env:SECRET_SAUCE
      Write-Host But I can read $(secret.Sauce) "(but the log is redacted so I do not spoil the secret)"

#!/bin/bash
echo "##vso[task.setvariable variable=sauce]crushed tomatoes"
echo "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic"

"$(sauce)" "$(secret.Sauce)"

#!/bin/bash
echo "No problem reading $SAUCE"
echo "But I cannot read $SECRET_SAUCE"

Output della console dalla lettura delle variabili:

No problem reading crushed tomatoes or crushed tomatoes
But I cannot read 
But I can read ******** (but the log is redacted so I do not spoil the secret)

Visualizzare i valori correnti di tutte le variabili

1. Selezionare Versioni pipeline>e quindi selezionare la pipeline di versione.

2. Aprire la visualizzazione di riepilogo per la versione e selezionare la fase a cui si è interessati. Nell'elenco dei passaggi scegliere Inizializza processo.

   

3. Verranno aperti i log per questo passaggio. Scorrere verso il basso per visualizzare i valori usati dall'agente per questo processo.

   

Eseguire una versione in modalità di debug

L'esecuzione di una versione in modalità di debug consente di diagnosticare e risolvere i problemi o gli errori visualizzando informazioni aggiuntive durante l'esecuzione del rilascio. È possibile abilitare la modalità di debug per l'intera versione o solo per le attività all'interno di una fase di rilascio specifica.

• Per abilitare la modalità di debug per un'intera versione, aggiungere una variabile denominata System.Debug con il valore true alla scheda Variabili della pipeline di versione.

• Per abilitare la modalità di debug per una fase specifica, aprire la finestra di dialogo Configura fase dal menu di scelta rapida della fase e aggiungere una variabile denominata System.Debug con il valore true alla scheda Variabili .

• In alternativa, creare un gruppo di variabili contenente una variabile denominata System.Debug con il valore truee collegare questo gruppo di variabili alla pipeline di versione.

Contenuto correlato

• Origini degli artefatti nelle pipeline di versione classica

• Distribuire gli artefatti delle richieste pull

• Usare le variabili in un gruppo di variabili