Använda variabler i klassiska versionspipelines

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Att använda variabler i klassiska versionspipelines är ett bekvämt sätt att utbyta och transportera data i hela pipelinen. Varje variabel lagras som en sträng och dess värde kan ändras mellan pipelinekörningar.

När du konfigurerar uppgifter för att distribuera ditt program i varje steg i den klassiska versionspipelinen kan variabler hjälpa dig:

• Förenkla anpassningen: Definiera en allmän distributionspipeline en gång och anpassa den enkelt för olika steg. Använd till exempel en variabel för att representera en webbdistributions niska veze och justera dess värde efter behov för varje steg. Dessa kallas anpassade variabler.

• Använd sammanhangsbaserad information: Åtkomstinformation om versionskontexten, till exempel en fas, en artefakt eller agenten som kör distributionen. Skripten kan till exempel kräva byggplatsen för nedladdning eller agentens arbetskatalog för att skapa temporära filer. Dessa kallas för standardvariabler.

Standardvariabler

Standardvariabler ger viktig information om körningskontexten för dina aktiviteter och skript som körs. Med de här variablerna kan du komma åt information om systemet, versionen, fasen eller agenten där de körs.

Med undantag för System.Debug är standardvariabler skrivskyddade, och deras värden anges automatiskt av systemet.

Några av de viktigaste variablerna beskrivs i följande tabeller. Om du vill visa den fullständiga listan kan du läsa Visa aktuella värden för alla variabler.

Systemvariabler

Versionsvariabler

Versionsstegsvariabler

Agentvariabler

Versionsartefaktvariabler

För varje artefakt som refereras till i en version kan du använda följande artefaktvariabler. Observera att inte alla variabler gäller för varje artefakttyp. Tabellen nedan visar standardartefaktvariabler och innehåller exempel på deras värden baserat på artefakttypen. Om ett exempel är tomt anger det att variabeln inte är tillämplig för den artefakttypen.

{alias} Ersätt platshållaren med det värde som du angav för artefaktkällans alias eller med standardvärdet som genererats för versionspipelinen.

Primära artefaktvariabler

Om du använder flera artefakter i klassiska versionspipelines kan du ange en som den primära artefakten. Azure Pipelines fyller sedan i följande variabler för den avsedda primära artefakten.

Använda standardvariabler

Du kan använda standardvariablerna på två sätt: som parametrar för uppgifter i en versionspipeline eller i skripten.

Du kan använda en standardvariabel direkt som indata till en uppgift. Om du till exempel vill skicka Release.Artifacts.{Artifact alias}.DefinitionName som ett argument till en PowerShell-uppgift för en artefakt med ASPNET4.CI som alias använder $(Release.Artifacts.ASPNET4.CI.DefinitionName)du .

Om du vill använda en standardvariabel i skriptet måste du först ersätta . i standardvariabelnamnen med _. Om du till exempel vill skriva ut värdet Release.Artifacts.{Artifact alias}.DefinitionName för för en artefakt med ASPNET4.CI som alias i ett PowerShell-skript använder du $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. Observera att det ursprungliga aliaset, ASPNET4.CI, ersätts med ASPNET4_CI.

Anpassade variabler

Anpassade variabler kan definieras i olika omfång.

• Variabelgrupper: Använd variabelgrupper för att dela värden i alla definitioner i ett projekt. Detta är användbart när du vill använda samma värden i definitioner, faser och aktiviteter i ett projekt och hantera dem från en enda plats. Definiera och hantera variabelgrupper i pipelinebiblioteket>.

• Versionspipelinevariabler: Använd versionspipelinevariabler för att dela värden i alla steg i en versionspipeline. Detta är idealiskt för scenarier där du behöver ett konsekvent värde mellan faser och uppgifter, med möjlighet att uppdatera det från en enda plats. Definiera och hantera dessa variabler på fliken Variabler i versionspipelinen. På sidan Pipelinevariabler anger du listrutan Omfång till Släpp när du lägger till en variabel.

• Stegvariabler: Använd stegvariabler för att dela värden inom en specifik fas i en versionspipeline. Detta är användbart för värden som skiljer sig från steg till steg men är konsekventa för alla aktiviteter i en fas. Definiera och hantera dessa variabler på fliken Variabler i versionspipelinen. På sidan Pipelinevariabler anger du listrutan Omfång till lämplig miljö när du lägger till en variabel.

Med hjälp av anpassade variabler i projektet, versionspipelinen och stegnivåerna kan du:

• Undvik att duplicera värden, vilket gör det enklare att uppdatera alla förekomster med en enda ändring.

• Skydda känsliga värden genom att förhindra att de visas eller ändras av användare. Om du vill markera en variabel som säker (hemlighet) väljer du ikonen bredvid variabeln.

  Viktigt!

  Värdena för de dolda variablerna (hemligheten) lagras säkert på servern och kan inte visas av användarna när de har sparats. Under distributionen dekrypterar Azure Pipelines dessa värden när de refereras av uppgifter och skickar dem till agenten via en säker HTTPS-kanal.

Använda anpassade variabler

Om du vill använda anpassade variabler i dina aktiviteter omger du variabelnamnet inom parenteser och föregår det med ett $ tecken. Om du till exempel har en variabel med namnet adminUserName kan du infoga dess aktuella värde i en aktivitet som $(adminUserName).

Definiera och ändra variabler i ett skript

Om du vill definiera eller ändra en variabel från ett skript använder du loggningskommandot task.setvariable . Det uppdaterade variabelvärdet är begränsat till det jobb som körs och bevaras inte mellan jobb eller faser. Observera att variabelnamn omvandlas till versaler, med "." och " " ersatta med "_".

Till exempel kommer Agent.WorkFolder att bli AGENT_WORKFOLDER.

• I Windows får du åtkomst till den här variabeln som %AGENT_WORKFOLDER% eller $env:AGENT_WORKFOLDER.
• I Linux och macOS använder du $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"

Konsolutdata från att läsa variablerna:

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)

Visa aktuella värden för alla variabler

1. Välj Pipelines-versioner> och välj sedan din versionspipeline.

2. Öppna sammanfattningsvyn för din version och välj den fas som du är intresserad av. I listan med steg väljer du Initiera jobb.

   

3. Då öppnas loggarna för det här steget. Rulla nedåt för att se de värden som används av agenten för det här jobbet.

   

Kör en version i felsökningsläge

Om du kör en version i felsökningsläge kan du diagnostisera och lösa problem eller fel genom att visa ytterligare information under versionskörningen. Du kan aktivera felsökningsläge för hela versionen eller bara för aktiviteterna i en specifik versionsfas.

• Om du vill aktivera felsökningsläge för en hel version lägger du till en variabel med namnet System.Debug med värdet true på fliken Variabler i versionspipelinen.

• Om du vill aktivera felsökningsläge för en viss fas öppnar du dialogrutan Konfigurera fas från snabbmenyn i fasen och lägger till en variabel med namnet System.Debug med värdet true på fliken Variabler .

• Du kan också skapa en variabelgrupp som innehåller en variabel med namnet System.Debug med värdet trueoch länka den här variabelgruppen till versionspipelinen.

Relaterat innehåll

• Artefaktkällor i klassiska versionspipelines

• Distribuera artefakter för pull-begäran

• Använda variabler i en variabelgrupp