Variabelen gebruiken in klassieke release-pijplijnen

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

Het gebruik van variabelen in klassieke release-pijplijnen is een handige manier om gegevens in uw pijplijn uit te wisselen en te transporteren. Elke variabele wordt opgeslagen als een tekenreeks en de waarde kan veranderen tussen pijplijnuitvoeringen.

Wanneer u taken instelt voor het implementeren van uw toepassing in elke fase van uw klassieke release-pijplijn, kunnen variabelen u helpen:

• Aanpassing vereenvoudigen: Definieer eenmaal een algemene implementatiepijplijn en pas deze eenvoudig aan voor verschillende fasen. Gebruik bijvoorbeeld een variabele om de verbindingsreeks van een webimplementatie weer te geven, waarbij u de waarde zo nodig voor elke fase aanpast. Deze variabelen worden aangepaste variabelen genoemd.

• Gebruik contextuele informatie: krijg toegang tot details over de releasecontext, zoals een fase, een artefact of de agent waarop de implementatie wordt uitgevoerd. Uw scripts kunnen bijvoorbeeld de buildlocatie vereisen voor downloaden of de werkmap van de agent om tijdelijke bestanden te maken. Deze variabelen worden standaardvariabelen genoemd.

Standaardvariabelen

Standaardvariabelen bieden essentiële informatie over de uitvoeringscontext voor uw actieve taken en scripts. Deze variabelen bieden u toegang tot details over het systeem, de release, de fase of de agent waarin ze worden uitgevoerd.

Met uitzondering van System.Debug zijn standaardvariabelen alleen-lezen en stelt het systeem automatisch hun waarden in.

Sommige van de belangrijkste variabelen worden beschreven in de volgende tabellen. Zie De huidige waarden van alle variabelen weergeven om de volledige lijst weer te geven.

Systeemvariabelen

Variabelen vrijgeven

Release-fase variabelen

Agentvariabelen

Variabelen voor artefacten vrijgeven

Gebruik de volgende artefactvariabelen voor elk artefact waarnaar u in een release verwijst. Houd er rekening mee dat niet alle variabelen van toepassing zijn op elk artefacttype. De volgende tabel bevat standaardvariabelen voor artefacten en bevat voorbeelden van hun waarden op basis van het artefacttype. Als een voorbeeld leeg is, geeft dit aan dat de variabele niet van toepassing is op dat artefacttype.

Vervang de {alias} tijdelijke aanduiding door de waarde die u opgeeft voor de artefactbronalias of door de standaardwaarde die is gegenereerd voor de release-pijplijn.

Variabelen voor primaire artefacten

Als u meerdere artefacten gebruikt, kunt u in klassieke releasepijplijnen één artefact aanwijzen als het primaire artefact. Azure Pipelines vult vervolgens de volgende variabelen voor het aangewezen primaire artefact.

Standaardvariabelen gebruiken

U kunt de standaardvariabelen op twee manieren gebruiken: als parameters voor taken in een release-pijplijn of in uw scripts.

Gebruik een standaardvariabele rechtstreeks als invoer voor een taak. Als u bijvoorbeeld als argument wilt doorgeven Release.Artifacts.{Artifact alias}.DefinitionName aan een PowerShell-taak voor een artefact met ASPNET4.CI als alias, gebruikt u $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Als u een standaardvariabele in uw script wilt gebruiken, vervangt u de . standaardvariabelenamen door _. Als u bijvoorbeeld de waarde van Release.Artifacts.{Artifact alias}.DefinitionName van een artefact wilt printen met ASPNET4.CI als alias in een PowerShell-script, gebruikt u $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. De oorspronkelijke alias, ASPNET4.CI, wordt vervangen door ASPNET4_CI.

Aangepaste variabelen

U kunt aangepaste variabelen definiëren voor verschillende bereiken.

• Variabelegroepen: gebruik variabelegroepen om waarden te delen in alle definities in een project. Deze benadering is handig als u dezelfde waarden wilt gebruiken in definities, fasen en taken binnen een project en deze vanaf één locatie wilt beheren. Variabelengroepen definiëren en beheren in de Pijplijnen>Bibliotheek.

• Release-pijplijnvariabelen: gebruik releasepijplijnvariabelen om waarden te delen in alle fasen binnen een release-pijplijn. Deze benadering is ideaal voor scenario's waarbij u een consistente waarde nodig hebt voor fasen en taken, met de mogelijkheid om deze vanaf één locatie bij te werken. Definieer en beheer deze variabelen op het tabblad Variabelen van de release-pijplijn. Stel op de pagina Pijplijnvariabelen de vervolgkeuzelijst Bereik in op Release wanneer u een variabele toevoegt.

• Fasevariabelen: gebruik fasevariabelen om waarden te delen binnen een specifieke fase van een release-pijplijn. Deze benadering is handig voor waarden die verschillen van fase tot fase, maar consistent zijn voor alle taken binnen een fase. Definieer en beheer deze variabelen op het tabblad Variabelen van de release-pijplijn. Stel op de pagina Pijplijnvariabelen de vervolgkeuzelijst Bereik in op de juiste omgeving bij het toevoegen van een variabele.

Met behulp van aangepaste variabelen op project-, release-pijplijn- en faseniveaus kunt u het volgende doen:

• Vermijd het dupliceren van waarden, waardoor het eenvoudiger is om alle exemplaren bij te werken met één wijziging.

• Beveilig gevoelige waarden door te voorkomen dat ze door gebruikers worden bekeken of gewijzigd. Als u een variabele als veilig (geheim) wilt markeren, selecteert u het pictogram naast de variabele.

  Belangrijk

  De waarden van de verborgen variabelen (geheim) worden veilig opgeslagen op de server en gebruikers kunnen ze niet bekijken nadat ze zijn opgeslagen. Tijdens de implementatie ontsleutelt Azure Pipelines deze waarden wanneer taken ernaar verwijzen en doorgeven aan de agent via een beveiligd HTTPS-kanaal.

Aangepaste variabelen gebruiken

Als u aangepaste variabelen in uw taken wilt gebruiken, plaatst u de naam van de variabele tussen haakjes en plaatst u deze vóór een $ teken. Als u bijvoorbeeld een variabele met de naam adminUserName hebt, voegt u de huidige waarde in een taak in als $(adminUserName).

Uw variabelen definiëren en wijzigen in een script

Als u een variabele van een script wilt definiëren of wijzigen, gebruikt u de task.setvariable opdracht voor logboekregistratie. De bijgewerkte variabelewaarde is gericht op de taak die wordt uitgevoerd en blijft niet behouden tussen taken of fasen. Houd er rekening mee dat namen van variabelen worden omgezet in hoofdletters, met '.' en '' vervangen door '_'.

Zo wordt Agent.WorkFolder gewijzigd in AGENT_WORKFOLDER.

• Toegang krijgen tot deze variabele op Windows als %AGENT_WORKFOLDER% of $env:AGENT_WORKFOLDER.
• Gebruik in Linux en macOS $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"

Console-uitvoer van het lezen van de variabelen:

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)

De huidige waarden van alle variabelen weergeven

1. Selecteer Pijplijnen>Releases, en selecteer vervolgens uw release-pijplijn.

2. Open de overzichtsweergave voor uw release en selecteer de fase waarin u geïnteresseerd bent. In de lijst met stappen, kies Initialiseer taak.

   

3. Met deze stap worden de logboeken geopend. Schuif omlaag om de waarden te zien die de agent gebruikt voor deze taak.

   

Een release uitvoeren in de foutopsporingsmodus

Als u een release uitvoert in de foutopsporingsmodus, kunt u problemen vaststellen en oplossen door extra informatie weer te geven tijdens de uitvoering van de release. U kunt de foutopsporingsmodus voor de hele release inschakelen of alleen voor de taken in een specifieke releasefase.

• Als u de foutopsporingsmodus voor de hele release wilt inschakelen, voegt u een variabele met de naam System.Debug met de waarde true toe aan het tabblad Variabelen van de release-pijplijn.

• Als u de foutopsporingsmodus voor een specifieke fase wilt inschakelen, opent u het dialoogvenster Fase configureren vanuit het snelmenu van de fase en voegt u een variabele met de naam System.Debug met de waarde true toe aan het tabblad Variabelen .

• U kunt ook een variabelegroep maken met een variabele met de naam System.Debug van de waarde trueen deze variabelegroep koppelen aan de release-pijplijn.

Gerelateerde inhoud

• Artefactbronnen in klassieke releasepijplijnen

• Artefacten voor pull-aanvragen implementeren

• Variabelen gebruiken in een variabelegroep