Använd fördefinierade variabler
Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019
Med variabler får du ett bekvämt sätt att få viktiga databitar i olika delar av din pipeline. Det här är en lista över fördefinierade variabler som du kan använda. Det kan finnas några andra fördefinierade variabler, men de är främst för internt bruk.
Dessa variabler anges automatiskt av systemet och skrivskyddas. (Undantagen är Build.Clean och System.Debug.)
I YAML-pipelines kan du referera till fördefinierade variabler som miljövariabler. Variabeln Build.ArtifactStagingDirectory
blir till exempel variabeln BUILD_ARTIFACTSTAGINGDIRECTORY
.
För klassiska pipelines kan du använda versionsvariabler i dina distributionsuppgifter för att dela den gemensamma informationen (till exempel miljönamn, resursgrupp osv.).
Läs mer om att arbeta med variabler.
Build.Clean
Det här är en inaktuell variabel som ändrar hur byggagenten rensar källan. Information om hur du rensar källan finns i Rensa den lokala lagringsplatsen på agenten.
System.AccessToken
System.AccessToken
är en särskild variabel som bär den säkerhetstoken som används av den version som körs.
I YAML måste du uttryckligen mappa System.AccessToken
till pipelinen med hjälp av en variabel. Du kan göra detta på steg- eller aktivitetsnivå:
steps:
- script: |
echo "Using System.AccessToken to authenticate"
git clone https://$(System.AccessToken)@dev.azure.com/yourorganization/yourproject/_git/yourrepository
displayName: 'Clone repository using System.AccessToken'
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
Du kan konfigurera standardomfånget för att använda auktoriseringsomfånget för System.AccessToken
byggjobb.
System.Debug
Om du vill ha mer detaljerade loggar för att felsöka pipelineproblem definierar System.Debug
du och anger det till true
.
Redigera din pipeline.
Välj variabler.
Lägg till en ny variabel med namnet
System.Debug
och värdettrue
.Spara den nya variabeln.
Inställning System.Debug
för att true
konfigurera utförliga loggar för alla körningar. Du kan också konfigurera utförliga loggar för en enda körning med kryssrutan Aktivera systemdiagnostik .
Du kan också ange System.Debug
som true
en variabel i en pipeline eller mall.
variables:
system.debug: 'true'
När System.Debug
är inställt på true
anges en extra variabel med namnet Agent.Diagnostic
till true
. När Agent.Diagnostic
är true
samlar agenten in fler loggar som kan användas för att felsöka nätverksproblem för lokalt installerade agenter. Mer information finns i Nätverksdiagnostik för lokalt installerade agenter.
Kommentar
Variabeln Agent.Diagnostic
är tillgänglig med Agent v2.200.0 och senare.
Mer information finns i Granska loggar för att diagnostisera pipelineproblem.
Agentvariabler (DevOps Services)
Kommentar
Du kan använda agentvariabler som miljövariabler i skripten och som parametrar i dina bygguppgifter. Du kan inte använda dem för att anpassa versionsnumret eller för att använda en etikett eller tagg för versionskontroll.
Olika | beskrivning |
---|---|
Agent.BuildDirectory | Den lokala sökvägen på agenten där alla mappar för en viss bygg-pipeline skapas. Den här variabeln har samma värde som Pipeline.Workspace . Exempel: /home/vsts/work/1 . |
Agent.ContainerMapping | En mappning från containerresursnamn i YAML till deras Docker-ID vid körning. Exempel följer tabell. |
Agent.HomeDirectory | Katalogen som agenten är installerad i. Detta innehåller agentprogramvaran. Exempel: c:\agent . |
Agent.Id | Agentens ID. |
Agent.JobName | Namnet på det jobb som körs. Detta är vanligtvis "Jobb"; eller "__default", men i scenarier med flera konfigurationer är konfigurationen. |
Agent.JobStatus | Status för bygget.
AGENT_JOBSTATUS . Den äldre agent.jobstatus är tillgänglig för bakåtkompatibilitet. |
Agent.MachineName | Namnet på den dator där agenten är installerad. |
Agent.Name | Namnet på agenten som är registrerad i poolen. Om du använder en lokalt installerad agent anges det här namnet av dig. Se agenter. |
Agent.OS | Agentvärdens operativsystem. Giltiga värden är:
|
Agent.OSArchitecture | Agentvärdens processorarkitektur för operativsystemet. Giltiga värden är:
|
Agent.TempDirectory | En tillfällig mapp som rensas efter varje pipelinejobb. Den här katalogen används av uppgifter som .NET Core CLI-uppgift för att lagra tillfälliga objekt som testresultat innan de publiceras. Till exempel: /home/vsts/work/_temp för Ubuntu. |
Agent.ToolsDirectory | Katalogen som används av uppgifter som Installationsprogram för nodverktyg och Använd Python-version för att växla mellan flera versioner av ett verktyg. Dessa uppgifter lägger till verktyg från den här katalogen så PATH att efterföljande byggsteg kan använda dem.Lär dig mer om att hantera den här katalogen på en lokalt installerad agent. |
Agent.WorkFolder | Arbetskatalogen för den här agenten. Exempel: c:\agent_work .Obs! Den här katalogen är inte garanterad att vara skrivbar av pipelineaktiviteter (till exempel när den mappas till en container) |
Exempel på Agent.ContainerMapping:
{
"one_container": {
"id": "bdbb357d73a0bd3550a1a5b778b62a4c88ed2051c7802a0659f1ff6e76910190"
},
"another_container": {
"id": "82652975109ec494876a8ccbb875459c945982952e0a72ad74c91216707162bb"
}
}
Skapa variabler (DevOps Services)
När du använder en variabel i en mall som inte är markerad som tillgänglig i mallar återges inte variabeln. Variabeln återges inte eftersom dess värde inte är tillgängligt inom mallens omfång.
Olika | beskrivning | Är du tillgänglig i mallar? |
---|---|---|
Build.ArtifactStagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a .Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BuildId | ID:t för posten för den slutförda versionen. | Nej |
Build.BuildNumber | Namnet på den färdiga versionen, även kallat körningsnumret. Du kan ange vad som ingår i det här värdet. En vanlig användning av den här variabeln är att göra den till en del av etikettformatet, som du anger på fliken lagringsplats. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BuildUri | URI:n för bygget. Exempel: vstfs:///Build/Build/1430 .Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BinariesDirectory | Den lokala sökvägen på agenten som du kan använda som utdatamapp för kompilerade binärfiler. Som standard konfigureras inte nya byggpipelines för att rensa den här katalogen. Du kan definiera din version för att rensa den på fliken Lagringsplats. Exempel: c:\agent_work\1\b .Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.ContainerId | ID:t för containern för artefakten. När du laddar upp en artefakt i pipelinen läggs den till i en container som är specifik för just den artefakten. | Nej |
Build.CronSchedule.DisplayName | Det displayName cron-schema som utlöste pipelinekörningen. Den här variabeln anges bara om pipelinekörningen utlöses av en schemalagd YAML-utlösare. Mer information finns i schedules.cron definition – Variabeln Build.CronSchedule.DisplayName |
Ja |
Build.DefinitionName | Namnet på bygg-pipeline. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.DefinitionVersion | Versionen av bygg-pipelinen. | Ja |
Build.QueuedBy | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.QueuedById | Se "Hur anges identitetsvariablerna?". | Ja |
Build.Reason | Händelsen som gjorde att bygget kördes.
|
Ja |
Build.Repository.Clean | Värdet som du har valt för Rensa i källlagringsplatsens inställningar. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.LocalPath | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s .Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Viktigt: Om du bara checkar ut en Git-lagringsplats är den här sökvägen den exakta sökvägen till koden. Om du checkar ut flera lagringsplatser är beteendet följande (och kan skilja sig från värdet för variabeln Build.SourcesDirectory):
|
Nej |
Build.Repository.ID | Den unika identifieraren för lagringsplatsen. Detta ändras inte, även om namnet på lagringsplatsen gör det. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Name | Namnet på den utlösande lagringsplatsen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Provider | Typen av utlösande lagringsplats.
|
Nej |
Build.Repository.Tfvc.Workspace | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Namnet på TFVC-arbetsytan som används av byggagenten. Om till exempel Agent.BuildDirectory är c:\agent_work\12 och Agent.Id är 8 kan arbetsytans namn vara: ws_12_8 Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Uri | URL:en för den utlösande lagringsplatsen. Till exempel: Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.RequestedFor | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.RequestedForEmail | Se "Hur anges identitetsvariablerna?". | Ja |
Build.RequestedForId | Se "Hur anges identitetsvariablerna?". | Ja |
Build.SourceBranch | Grenen av den utlösande lagringsplatsen som bygget stod i kö för. Några exempel:
/ ) med understreckstecken _ ).Obs! Om du kör en gated check-in-version i TFVC eller skapar en hylloruppsättning manuellt kan du inte använda den här variabeln i ditt versionsnummerformat. |
Ja |
Build.SourceBranchName | Namnet på grenen i den utlösande lagringsplatsen som kompileringen stod i kö för.
|
Ja |
Build.SourcesDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s .Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Viktigt: Om du bara checkar ut en Git-lagringsplats är den här sökvägen den exakta sökvägen till koden. Om du checkar ut flera lagringsplatser återgår den till standardvärdet, vilket är $(Pipeline.Workspace)/s , även om den primära lagringsplatsen (den primära) är utcheckad till en anpassad sökväg som skiljer sig från standardsökvägen $(Pipeline.Workspace)/s/<RepoName> för flera utcheckningar (i det här avseendet skiljer sig variabeln från beteendet för variabeln Build.Repository.LocalPath).Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.SourceVersion | Den senaste versionen styr ändringen av den utlösande lagringsplatsen som ingår i den här versionen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
Build.SourceVersionMessage | Kommentaren för incheckningen eller ändringsuppsättningen för den utlösande lagringsplatsen. Vi trunkerar meddelandet till den första raden eller 200 tecken, beroende på vilket som är kortare. Motsvarar Build.SourceVersionMessage meddelandet vid Build.SourceVersion incheckningen. Incheckningen Build.SourceVersion för en PR-version är sammanslagningsincheckningen (inte incheckningen på källgrenen).Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Dessutom är den här variabeln endast tillgänglig på stegnivå och är inte tillgänglig på jobb- eller fasnivåerna (det vill: meddelandet extraheras inte förrän jobbet startar och koden är utcheckad). Obs! Den här variabeln är tillgänglig i TFS 2015.4. Obs! Variabeln Build.SourceVersionMessage fungerar inte med klassiska byggpipelines i Bitbucket-lagringsplatser när Batch ändras medan en version pågår är aktiverad. |
Nej |
Build.StagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a .Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Git.SubmoduleCheckout | Det värde som du har valt för Checkout-undermoduler på fliken lagringsplats. När flera lagringsplatser är utcheckade spårar det här värdet inställningen för den utlösande lagringsplatsen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.SourceTfvcShelveset | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Om du kör en gated build eller en hyllor bygge, detta är inställt på namnet på den hyllor du bygger. Obs! Den här variabeln ger ett ogiltigt värde för bygganvändning i ett versionsnummerformat. |
Nej |
Build.TriggeredBy.BuildId | Om bygget utlöstes av en annan version ställs den här variabeln in på BuildID för den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.DefinitionId | Om bygget utlöstes av en annan version anges den här variabeln till DefinitionID för den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.DefinitionName | Om bygget utlöstes av en annan version anges den här variabeln till namnet på den utlösande bygg-pipelinen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.BuildNumber | Om bygget utlöstes av en annan version anges den här variabeln till antalet utlösande versioner. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.ProjectID | Om bygget utlöstes av en annan version ställs den här variabeln in på ID för projektet som innehåller den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Common.TestResultsDirectory | Den lokala sökvägen på agenten där testresultaten skapas. Exempel: c:\agent_work\1\TestResults .Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Pipelinevariabler (DevOps Services)
Olika | beskrivning |
---|---|
Pipeline.Workspace | Arbetsytekatalog för en viss pipeline. Den här variabeln har samma värde som Agent.BuildDirectory . Exempel: /home/vsts/work/1 |
Dricks
Om du använder klassiska versionspipelines kan du använda klassiska versioner och artefakter för att lagra och komma åt data i hela pipelinen.
Distributionsjobbvariabler (DevOps Services)
Dessa variabler är begränsade till ett specifikt distributionsjobb och löses endast vid jobbkörning.
Olika | beskrivning |
---|---|
Environment.Name | Namnet på den miljö som distributionsjobbet riktar sig till för att köra distributionsstegen och registrera distributionshistoriken. Exempel: smarthotel-dev |
Environment.Id | ID för den miljö som är mål för distributionsjobbet. Exempel: 10 |
Environment.ResourceName | Namnet på den specifika resursen i den miljö som distributionsjobbet riktar sig till för att köra distributionsstegen och registrera distributionshistoriken. Till exempel, bookings vilket är ett Kubernetes-namnområde som har lagts till som en resurs i miljön smarthotel-dev . |
Environment.ResourceId | ID för den specifika resursen i miljön som är mål för distributionsjobbet för att köra distributionsstegen. Exempel: 4 |
Strategy.Name | Namnet på distributionsstrategin: canary , runOnce eller rolling . |
Strategy.CycleName | Det aktuella cykelnamnet i en distribution. Alternativen är PreIteration , Iteration eller PostIteration . |
Systemvariabler (DevOps Services)
När du använder en variabel i en mall som inte är markerad som tillgänglig i mallar återges inte variabeln. Variabeln återges inte eftersom dess värde inte är tillgängligt inom mallens omfång.
Olika | beskrivning | Är du tillgänglig i mallar? |
---|---|---|
System.AccessToken | Använd OAuth-token för att komma åt REST-API:et. Använd System.AccessToken från YAML-skript. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.CollectionId | GUID för TFS-samlingen eller Azure DevOps-organisationen. | Ja |
System.CollectionUri | URI:n för TFS-samlingen eller Azure DevOps-organisationen. Exempel: https://dev.azure.com/fabrikamfiber/ . |
Ja |
System.DefaultWorkingDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Till exempel: c:\agent_work\1\s Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.DefinitionId | ID:t för bygg-pipelinen. | Ja |
System.HostType | Ange till build om pipelinen är en version. För en version är deployment värdena för ett distributionsgruppjobb, gates under utvärderingen av portar och release för andra (agent- och agentlösa) jobb. |
Ja |
System.JobAttempt | Ange till 1 första gången det här jobbet görs och ökas varje gång jobbet görs på nytt. | Nej |
System.JobDisplayName | Det människoläsbara namn som ges till ett jobb. | Nej |
System.JobId | En unik identifierare för ett enda jobbförsök. Värdet är unikt för den aktuella pipelinen. | Nej |
System.JobName | Namnet på jobbet, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.OidcRequestUri | Generera en idToken för autentisering med Entra-ID med hjälp av OpenID Connect (OIDC). Läs mer. |
Ja |
System.PhaseAttempt | Ange till 1 första gången den här fasen görs och ökas varje gång jobbet görs på nytt. Obs! "Fas" är ett mestadels redundant begrepp som representerar designtiden för ett jobb (medan jobbet var körningsversionen av en fas). Vi har mestadels tagit bort begreppet "fas" från Azure Pipelines. Matris- och multikonfigurationsjobb är den enda plats där "fas" fortfarande skiljer sig från "jobb". En fas kan instansiera flera jobb, som bara skiljer sig åt i sina indata. |
Nej |
System.PhaseDisplayName | Det människoläsbara namn som ges till en fas. | Nej |
System.PhaseName | En strängbaserad identifierare för ett jobb, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.PlanId | En strängbaserad identifierare för en enda pipelinekörning. | Nej |
System.PullRequest.IsFork | Om pull-begäran kommer från en förgrening av lagringsplatsen är den här variabeln inställd på True .Annars är den inställd på False . |
Ja |
System.PullRequest.PullRequestId | ID för pull-begäran som orsakade den här versionen. Exempel: 17 . (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). |
Nej |
System.PullRequest.PullRequestNumber | Antalet pull-begäranden som orsakade den här versionen. Den här variabeln fylls i för pull-begäranden från GitHub som har ett annat pull-begärande-ID och pull-begärandenummer. Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. | Nej |
System.PullRequest.targetBranchName | Namnet på målgrenen för en pull-begäran. Den här variabeln kan användas i en pipeline för att villkorligt köra uppgifter eller steg baserat på målgrenen för pull-begäran. Du kanske till exempel vill utlösa en annan uppsättning tester eller kodanalysverktyg beroende på den gren som ändringarna sammanfogas till. | Nej |
System.PullRequest.SourceBranch | Grenen som granskas i en pull-begäran. Exempel: refs/heads/users/raisa/new-feature för Azure-lagringsplatser. (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. |
Nej |
System.PullRequest.SourceCommitId | Incheckningen som granskas i en pull-begäran. (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. | |
System.PullRequest.SourceRepositoryURI | URL:en till lagringsplatsen som innehåller pull-begäran. Exempel: https://dev.azure.com/ouraccount/_git/OurProject . |
Nej |
System.PullRequest.TargetBranch | Den gren som är målet för en pull-begäran. Till exempel: refs/heads/main när lagringsplatsen finns i Azure Repos och main när lagringsplatsen finns i GitHub. Den här variabeln initieras endast om bygget kördes på grund av en Git-PR som påverkas av en grenprincip. Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. |
Nej |
System.StageAttempt | Ange till 1 första gången det här steget görs och ökas varje gång jobbet görs på nytt. | Nej |
System.StageDisplayName | Det människoläsbara namn som ges till ett stadium. | Nej |
System.StageName | En strängbaserad identifierare för en fas, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.TeamFoundationCollectionUri | URI:n för TFS-samlingen eller Azure DevOps-organisationen. Exempel: https://dev.azure.com/fabrikamfiber/ .Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.TeamProject | Namnet på projektet som innehåller den här versionen. | Ja |
System.TeamProjectId | ID:t för projektet som den här versionen tillhör. | Ja |
System.TimelineId | En strängbaserad identifierare för körningsinformation och loggar för en enda pipelinekörning. | Nej |
TF_BUILD | Ange till True om skriptet körs av en bygguppgift.Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Kontrollerar variabler (DevOps Services)
Olika | beskrivning |
---|---|
Checks.StageAttempt | Ange till 1 första gången det här steget görs och ökas varje gång fasen görs på nytt. Den här variabeln kan bara användas inom ett godkännande eller söka efter en miljö. Du kan till exempel använda $(Checks.StageAttempt) i en kontroll av rest-API:et Invoke. |
Agentvariabler (DevOps Server 2022)
Kommentar
Du kan använda agentvariabler som miljövariabler i skripten och som parametrar i dina bygguppgifter. Du kan inte använda dem för att anpassa versionsnumret eller för att använda en etikett eller tagg för versionskontroll.
Olika | beskrivning |
---|---|
Agent.BuildDirectory | Den lokala sökvägen på agenten där alla mappar för en viss bygg-pipeline skapas. Den här variabeln har samma värde som Pipeline.Workspace . Exempel: /home/vsts/work/1 . |
Agent.ContainerMapping | En mappning från containerresursnamn i YAML till deras Docker-ID vid körning. Exempel följer tabell. |
Agent.HomeDirectory | Katalogen som agenten är installerad i. Detta innehåller agentprogramvaran. Exempel: c:\agent . |
Agent.Id | Agentens ID. |
Agent.JobName | Namnet på det jobb som körs. Detta är vanligtvis "Jobb" eller "__default", men i scenarier med flera konfigurationer är konfigurationen. |
Agent.JobStatus | Status för bygget.
AGENT_JOBSTATUS . Den äldre agent.jobstatus är tillgänglig för bakåtkompatibilitet. |
Agent.MachineName | Namnet på den dator där agenten är installerad. |
Agent.Name | Namnet på agenten som är registrerad i poolen. Om du använder en lokalt installerad agent anges det här namnet av dig. Se agenter. |
Agent.OS | Agentvärdens operativsystem. Giltiga värden är:
|
Agent.OSArchitecture | Agentvärdens processorarkitektur för operativsystemet. Giltiga värden är:
|
Agent.TempDirectory | En tillfällig mapp som rensas efter varje pipelinejobb. Den här katalogen används av uppgifter som .NET Core CLI-uppgift för att lagra tillfälliga objekt som testresultat innan de publiceras. Till exempel: /home/vsts/work/_temp för Ubuntu. |
Agent.ToolsDirectory | Katalogen som används av uppgifter som Installationsprogram för nodverktyg och Använd Python-version för att växla mellan flera versioner av ett verktyg. Dessa uppgifter lägger till verktyg från den här katalogen så PATH att efterföljande byggsteg kan använda dem.Lär dig mer om att hantera den här katalogen på en lokalt installerad agent. |
Agent.WorkFolder | Arbetskatalogen för den här agenten. Exempel: c:\agent_work .Obs! Den här katalogen kan inte skrivas av pipelineuppgifter (till exempel när den mappas till en container). |
Exempel på Agent.ContainerMapping:
{
"one_container": {
"id": "bdbb357d73a0bd3550a1a5b778b62a4c88ed2051c7802a0659f1ff6e76910190"
},
"another_container": {
"id": "82652975109ec494876a8ccbb875459c945982952e0a72ad74c91216707162bb"
}
}
Skapa variabler (DevOps Server 2022)
När du använder en variabel i en mall som inte är markerad som tillgänglig i mallar återges inte variabeln. Variabeln återges inte eftersom dess värde inte är tillgängligt inom mallens omfång.
Olika | beskrivning | Är du tillgänglig i mallar? |
---|---|---|
Build.ArtifactStagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a . Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BuildId | ID:t för posten för den slutförda versionen. | Nej |
Build.BuildNumber | Namnet på den färdiga versionen, även kallat körningsnumret. Du kan ange vad som ingår i det här värdet. En vanlig användning av den här variabeln är att göra den till en del av etikettformatet, som du anger på fliken lagringsplats. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BuildUri | URI:n för bygget. Exempel: vstfs:///Build/Build/1430 . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BinariesDirectory | Den lokala sökvägen på agenten som du kan använda som utdatamapp för kompilerade binärfiler. Som standard konfigureras inte nya byggpipelines för att rensa den här katalogen. Du kan definiera din version för att rensa den på fliken Lagringsplats. Exempel: c:\agent_work\1\b . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.ContainerId | ID:t för containern för artefakten. När du laddar upp en artefakt i pipelinen läggs den till i en container som är specifik för just den artefakten. | Nej |
Build.CronSchedule.DisplayName | Det displayName cron-schema som utlöste pipelinekörningen. Den här variabeln anges bara om pipelinekörningen utlöses av en schemalagd YAML-utlösare. Mer information finns i schedules.cron definition – variabeln Build.CronSchedule.DisplayName. Den här variabeln är tillgänglig i Azure DevOps Server 2022.1 och senare. |
Ja |
Build.DefinitionName | Namnet på bygg-pipeline. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.DefinitionVersion | Versionen av bygg-pipelinen. | Ja |
Build.QueuedBy | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.QueuedById | Se "Hur anges identitetsvariablerna?. | Ja |
Build.Reason | Händelsen som gjorde att bygget kördes.
|
Ja |
Build.Repository.Clean | Värdet som du har valt för Rensa i källlagringsplatsens inställningar. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.LocalPath | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s . Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Viktigt: Om du bara checkar ut en Git-lagringsplats är den här sökvägen den exakta sökvägen till koden. Om du checkar ut flera lagringsplatser är beteendet följande (och kan skilja sig från värdet för variabeln Build.SourcesDirectory):
|
Nej |
Build.Repository.ID | Den unika identifieraren för lagringsplatsen. Detta ändras inte, även om namnet på lagringsplatsen gör det. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Name | Namnet på den utlösande lagringsplatsen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Provider | Typen av utlösande lagringsplats.
|
Nej |
Build.Repository.Tfvc.Workspace | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Namnet på TFVC-arbetsytan som används av byggagenten. Om till exempel Agent.BuildDirectory är c:\agent_work\12 och Agent.Id är 8 kan arbetsytans namn vara: ws_12_8 .Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Uri | URL:en för den utlösande lagringsplatsen. Till exempel:Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. | Nej |
Build.RequestedFor | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.RequestedForEmail | Se "Hur anges identitetsvariablerna?". | Ja |
Build.RequestedForId | Se "Hur anges identitetsvariablerna?". | Ja |
Build.SourceBranch | Grenen av den utlösande lagringsplatsen som bygget stod i kö för. Några exempel:
/ ) med understreckstecken _ ).Obs! Om du kör en gated check-in-version i TFVC eller skapar en hylloruppsättning manuellt kan du inte använda den här variabeln i ditt versionsnummerformat. |
Ja |
Build.SourceBranchName | Namnet på grenen i den utlösande lagringsplatsen som kompileringen stod i kö för.
|
Ja |
Build.SourcesDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s . Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Viktigt: Om du bara checkar ut en Git-lagringsplats är den här sökvägen den exakta sökvägen till koden. Om du checkar ut flera lagringsplatser återgår den till standardvärdet, vilket är $(Pipeline.Workspace)/s , även om den primära lagringsplatsen (den primära) är utcheckad till en anpassad sökväg som skiljer sig från standardsökvägen $(Pipeline.Workspace)/s/<RepoName> för flera utcheckningar (i det här avseendet skiljer sig variabeln från beteendet för variabeln Build.Repository.LocalPath).Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.SourceVersion | Den senaste versionen styr ändringen av den utlösande lagringsplatsen som ingår i den här versionen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
Build.SourceVersionMessage | Kommentaren för incheckningen eller ändringsuppsättningen för den utlösande lagringsplatsen. Vi trunkerar meddelandet till den första raden eller 200 tecken, beroende på vilket som är kortare. Motsvarar Build.SourceVersionMessage meddelandet vid Build.SourceVersion incheckningen. Incheckningen Build.SourceVersion för en PR-version är sammanslagningsincheckningen (inte incheckningen på källgrenen). Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Dessutom är den här variabeln endast tillgänglig på stegnivå och är inte tillgänglig på jobb- eller fasnivåerna (det vill: meddelandet extraheras inte förrän jobbet startar och koden är utcheckad). Obs! Den här variabeln är tillgänglig i TFS 2015.4. Obs! Variabeln Build.SourceVersionMessage fungerar inte med klassiska byggpipelines i Bitbucket-lagringsplatser när Batch ändras medan en version pågår är aktiverad. |
Nej |
Build.StagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a . Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Git.SubmoduleCheckout | Det värde som du har valt för Checkout-undermoduler på fliken lagringsplats. När flera lagringsplatser är utcheckade spårar det här värdet inställningen för den utlösande lagringsplatsen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.SourceTfvcShelveset | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Om du kör en gated build eller en hyllor bygge, detta är inställt på namnet på den hyllor du bygger. Obs! Den här variabeln ger ett ogiltigt värde för bygganvändning i ett versionsnummerformat. |
Nej |
Build.TriggeredBy.BuildId | Om bygget utlöstes av en annan version ställs den här variabeln in på BuildID för den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.DefinitionId | Om bygget utlöstes av en annan version anges den här variabeln till DefinitionID för den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.DefinitionName | Om bygget utlöstes av en annan version anges den här variabeln till namnet på den utlösande bygg-pipelinen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.BuildNumber | Om bygget utlöstes av en annan version anges den här variabeln till antalet utlösande versioner. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Build.TriggeredBy.ProjectID | Om bygget utlöstes av en annan version ställs den här variabeln in på ID för projektet som innehåller den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Om du utlöser en YAML-pipeline med bör resources du använda resursvariablerna i stället. |
Nej |
Common.TestResultsDirectory | Den lokala sökvägen på agenten där testresultaten skapas. Exempel: c:\agent_work\1\TestResults . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Pipelinevariabler (DevOps Server 2022)
Olika | beskrivning |
---|---|
Pipeline.Workspace | Arbetsytekatalog för en viss pipeline. Den här variabeln har samma värde som Agent.BuildDirectory . Exempel: /home/vsts/work/1 |
Dricks
Om du använder klassiska versionspipelines kan du använda klassiska versioner och artefakter för att lagra och komma åt data i hela pipelinen.
Distributionsjobbvariabler (DevOps Server 2022)
Dessa variabler är begränsade till ett specifikt distributionsjobb och löses endast vid jobbkörning.
Olika | beskrivning |
---|---|
Environment.Name | Namnet på den miljö som distributionsjobbet riktar sig till för att köra distributionsstegen och registrera distributionshistoriken. Exempel: smarthotel-dev |
Environment.Id | ID för den miljö som är mål för distributionsjobbet. Exempel: 10 |
Environment.ResourceName | Namnet på den specifika resursen i den miljö som distributionsjobbet riktar sig till för att köra distributionsstegen och registrera distributionshistoriken. Till exempel, bookings vilket är ett Kubernetes-namnområde som har lagts till som en resurs i miljön smarthotel-dev . |
Environment.ResourceId | ID för den specifika resursen i miljön som är mål för distributionsjobbet för att köra distributionsstegen. Exempel: 4 |
Strategy.Name | Namnet på distributionsstrategin: canary , runOnce eller rolling . |
Strategy.CycleName | Det aktuella cykelnamnet i en distribution. Alternativen är PreIteration , Iteration eller PostIteration . |
Systemvariabler (DevOps Server 2022)
När du använder en variabel i en mall som inte är markerad som tillgänglig i mallar återges inte variabeln. Variabeln återges inte eftersom dess värde inte är tillgängligt inom mallens omfång.
Olika | beskrivning | Är du tillgänglig i mallar? |
---|---|---|
System.AccessToken | Använd OAuth-token för att komma åt REST-API:et. Använd System.AccessToken från YAML-skript. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.CollectionId | GUID för TFS-samlingen eller Azure DevOps-organisationen. | Ja |
System.CollectionUri | URI:n för TFS-samlingen eller Azure DevOps-organisationen. Exempel: https://dev.azure.com/fabrikamfiber/ . |
Ja |
System.DefaultWorkingDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Till exempel: c:\agent_work\1\s Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.DefinitionId | ID:t för bygg-pipelinen. | Ja |
System.HostType | Ange till build om pipelinen är en version. För en version är deployment värdena för ett distributionsgruppjobb, gates under utvärderingen av portar och release för andra (agent- och agentlösa) jobb. |
Ja |
System.JobAttempt | Ange till 1 första gången det här jobbet görs och ökas varje gång jobbet görs på nytt. | Nej |
System.JobDisplayName | Det människoläsbara namn som ges till ett jobb. | Nej |
System.JobId | En unik identifierare för ett enda jobbförsök. Värdet är unikt för den aktuella pipelinen. | Nej |
System.JobName | Namnet på jobbet, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.PhaseAttempt | Ange till 1 första gången den här fasen görs och ökas varje gång jobbet görs på nytt. Obs! "Fas" är ett mestadels redundant begrepp som representerar designtiden för ett jobb (medan jobbet var körningsversionen av en fas). Vi har mestadels tagit bort begreppet "fas" från Azure Pipelines. Matris- och multikonfigurationsjobb är den enda plats där "fas" fortfarande skiljer sig från "jobb". En fas kan instansiera flera jobb, som bara skiljer sig åt i sina indata. |
Nej |
System.PhaseDisplayName | Det människoläsbara namn som ges till en fas. | Nej |
System.PhaseName | En strängbaserad identifierare för ett jobb, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.PlanId | En strängbaserad identifierare för en enda pipelinekörning. | Nej |
System.PullRequest.IsFork | Om pull-begäran kommer från en förgrening av lagringsplatsen är den här variabeln inställd på True . Annars är den inställd på False . |
Ja |
System.PullRequest.PullRequestId | ID för pull-begäran som orsakade den här versionen. Exempel: 17 . (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). |
Nej |
System.PullRequest.PullRequestNumber | Antalet pull-begäranden som orsakade den här versionen. Den här variabeln fylls i för pull-begäranden från GitHub som har ett annat pull-begärande-ID och pull-begärandenummer. Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. | Nej |
System.PullRequest.targetBranchName | Namnet på målgrenen för en pull-begäran. Den här variabeln kan användas i en pipeline för att villkorligt köra uppgifter eller steg baserat på målgrenen för pull-begäran. Du kanske till exempel vill utlösa en annan uppsättning tester eller kodanalysverktyg beroende på den gren som ändringarna sammanfogas till. | Nej |
System.PullRequest.SourceBranch | Grenen som granskas i en pull-begäran. Exempel: refs/heads/users/raisa/new-feature för Azure-lagringsplatser. (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. |
Nej |
System.PullRequest.SourceRepositoryURI | URL:en till lagringsplatsen som innehåller pull-begäran. Exempel: https://dev.azure.com/ouraccount/_git/OurProject . |
Nej |
System.PullRequest.TargetBranch | Den gren som är målet för en pull-begäran. Till exempel: refs/heads/main när lagringsplatsen finns i Azure Repos och main när lagringsplatsen finns i GitHub. Den här variabeln initieras endast om bygget kördes på grund av en Git-PR som påverkas av en grenprincip. Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. |
Nej |
System.StageAttempt | Ange till 1 första gången det här steget görs och ökas varje gång fasen görs på nytt. | Nej |
System.StageDisplayName | Det människoläsbara namn som ges till ett stadium. | Nej |
System.StageName | En strängbaserad identifierare för en fas, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.TeamFoundationCollectionUri | URI:n för TFS-samlingen eller Azure DevOps-organisationen. Exempel: https://dev.azure.com/fabrikamfiber/ . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.TeamProject | Namnet på projektet som innehåller den här versionen. | Ja |
System.TeamProjectId | ID:t för projektet som den här versionen tillhör. | Ja |
System.TimelineId | En strängbaserad identifierare för körningsinformation och loggar för en enda pipelinekörning. | Nej |
TF_BUILD | Ange till True om skriptet körs av en bygguppgift. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Kontrollerar variabler (DevOps Server 2022)
Olika | beskrivning |
---|---|
Checks.StageAttempt | Ange till 1 första gången det här steget görs och ökas varje gång fasen görs på nytt. Den här variabeln kan bara användas inom ett godkännande eller söka efter en miljö. Du kan till exempel använda $(Checks.StageAttempt) i en kontroll av rest-API:et Invoke. |
Agentvariabler (DevOps Server 2020)
Kommentar
Du kan använda agentvariabler som miljövariabler i skripten och som parametrar i dina bygguppgifter. Du kan inte använda dem för att anpassa versionsnumret eller för att använda en etikett eller tagg för versionskontroll.
Olika | beskrivning |
---|---|
Agent.BuildDirectory | Den lokala sökvägen på agenten där alla mappar för en viss bygg-pipeline skapas. Den här variabeln har samma värde som Pipeline.Workspace . Exempel: /home/vsts/work/1 . |
Agent.HomeDirectory | Katalogen som agenten är installerad i. Detta innehåller agentprogramvaran. Exempel: c:\agent . |
Agent.Id | Agentens ID. |
Agent.JobName | Namnet på det jobb som körs. Detta är vanligtvis "Jobb" eller "__default", men i scenarier med flera konfigurationer är konfigurationen. |
Agent.JobStatus | Status för bygget.
AGENT_JOBSTATUS . Den äldre agent.jobstatus är tillgänglig för bakåtkompatibilitet. |
Agent.MachineName | Namnet på den dator där agenten är installerad. |
Agent.Name | Namnet på agenten som är registrerad i poolen. Om du använder en lokalt installerad agent anges det här namnet av dig. Se agenter. |
Agent.OS | Agentvärdens operativsystem. Giltiga värden är:
|
Agent.OSArchitecture | Agentvärdens processorarkitektur för operativsystemet. Giltiga värden är:
|
Agent.TempDirectory | En tillfällig mapp som rensas efter varje pipelinejobb. Den här katalogen används av uppgifter som .NET Core CLI-uppgift för att lagra tillfälliga objekt som testresultat innan de publiceras. Till exempel: /home/vsts/work/_temp för Ubuntu. |
Agent.ToolsDirectory | Katalogen som används av uppgifter som Installationsprogram för nodverktyg och Använd Python-version för att växla mellan flera versioner av ett verktyg. Dessa uppgifter lägger till verktyg från den här katalogen så PATH att efterföljande byggsteg kan använda dem. Lär dig mer om att hantera den här katalogen på en lokalt installerad agent. |
Agent.WorkFolder | Arbetskatalogen för den här agenten. Exempel: c:\agent_work . Obs! Den här katalogen är inte garanterad att vara skrivbar av pipelineaktiviteter (till exempel när den mappas till en container) |
Skapa variabler (DevOps Server 2020)
När du använder en variabel i en mall som inte är markerad som tillgänglig i mallar återges inte variabeln. Variabeln återges inte eftersom dess värde inte är tillgängligt inom mallens omfång.
Olika | beskrivning | Är du tillgänglig i mallar? |
---|---|---|
Build.ArtifactStagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a . Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BuildId | ID:t för posten för den slutförda versionen. | Nej |
Build.BuildNumber | Namnet på den färdiga versionen, även kallat körningsnumret. Du kan ange vad som ingår i det här värdet. En vanlig användning av den här variabeln är att göra den till en del av etikettformatet, som du anger på fliken lagringsplats. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BuildUri | URI:n för bygget. Exempel: vstfs:///Build/Build/1430 . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.BinariesDirectory | Den lokala sökvägen på agenten som du kan använda som utdatamapp för kompilerade binärfiler. Som standard konfigureras inte nya byggpipelines för att rensa den här katalogen. Du kan definiera din version för att rensa den på fliken Lagringsplats. Exempel: c:\agent_work\1\b . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.ContainerId | ID:t för containern för artefakten. När du laddar upp en artefakt i pipelinen läggs den till i en container som är specifik för just den artefakten. | Nej |
Build.DefinitionName | Namnet på bygg-pipeline. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.DefinitionVersion | Versionen av bygg-pipelinen. | Ja |
Build.QueuedBy | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.QueuedById | Se "Hur anges identitetsvariablerna?". | Ja |
Build.Reason | Händelsen som gjorde att bygget kördes.
|
Ja |
Build.Repository.Clean | Värdet som du har valt för Rensa i källlagringsplatsens inställningar. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.LocalPath | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s . Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Viktigt: Om du bara checkar ut en Git-lagringsplats är den här sökvägen den exakta sökvägen till koden. Om du checkar ut flera lagringsplatser är beteendet följande (och kan skilja sig från värdet för variabeln Build.SourcesDirectory):
|
Nej |
Build.Repository.ID | Den unika identifieraren för lagringsplatsen. Detta ändras inte, även om namnet på lagringsplatsen gör det. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Name | Namnet på den utlösande lagringsplatsen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Provider | Typen av utlösande lagringsplats.
|
Nej |
Build.Repository.Tfvc.Workspace | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Namnet på TFVC-arbetsytan som används av byggagenten. Om till exempel Agent.BuildDirectory är c:\agent_work\12 och Agent.Id är 8 kan arbetsytans namn vara: ws_12_8 . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Uri | URL:en för den utlösande lagringsplatsen. Till exempel: Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.RequestedFor | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Ja |
Build.RequestedForEmail | Se "Hur anges identitetsvariablerna?". | Ja |
Build.RequestedForId | Se "Hur anges identitetsvariablerna?". | Ja |
Build.SourceBranch | Grenen av den utlösande lagringsplatsen som bygget stod i kö för. Några exempel:
/ ) med understreckstecken _ ). Obs! Om du kör en gated check-in-version i TFVC eller skapar en hylloruppsättning manuellt kan du inte använda den här variabeln i ditt versionsnummerformat. |
Ja |
Build.SourceBranchName | Namnet på grenen i den utlösande lagringsplatsen som kompileringen stod i kö för.
|
Ja |
Build.SourcesDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s . Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Viktigt: Om du bara checkar ut en Git-lagringsplats är den här sökvägen den exakta sökvägen till koden. Om du checkar ut flera lagringsplatser återgår den till standardvärdet, vilket är $(Pipeline.Workspace)/s , även om den primära lagringsplatsen (den primära) är utcheckad till en anpassad sökväg som skiljer sig från standardsökvägen $(Pipeline.Workspace)/s/<RepoName> för flera utcheckningar (i det här avseendet skiljer sig variabeln från beteendet för variabeln Build.Repository.LocalPath). Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.SourceVersion | Den senaste versionen styr ändringen av den utlösande lagringsplatsen som ingår i den här versionen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
Build.SourceVersionMessage | Kommentaren för incheckningen eller ändringsuppsättningen för den utlösande lagringsplatsen. Vi trunkerar meddelandet till den första raden eller 200 tecken, beroende på vilket som är kortare. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Dessutom är den här variabeln endast tillgänglig på stegnivå och är inte tillgänglig på jobb- eller stegnivåerna (det vill: meddelandet extraheras inte förrän jobbet hade startat och checkat ut koden). Obs! Den här variabeln är tillgänglig i TFS 2015.4. Obs! Variabeln Build.SourceVersionMessage fungerar inte med klassiska byggpipelines i Bitbucket-lagringsplatser när Batch ändras medan en version pågår är aktiverad. |
Nej |
Build.StagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a . Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.Repository.Git.SubmoduleCheckout | Det värde som du har valt för Checkout-undermoduler på fliken lagringsplats. När flera lagringsplatser är utcheckade spårar det här värdet inställningen för den utlösande lagringsplatsen. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.SourceTfvcShelveset | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Om du kör en gated build eller en hyllor bygge, detta är inställt på namnet på den hyllor du bygger. Obs! Den här variabeln ger ett ogiltigt värde för bygganvändning i ett versionsnummerformat. |
Nej |
Build.TriggeredBy.BuildId | Om bygget utlöstes av en annan version ställs den här variabeln in på BuildID för den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.TriggeredBy.DefinitionId | Om bygget utlöstes av en annan version anges den här variabeln till DefinitionID för den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.TriggeredBy.DefinitionName | Om bygget utlöstes av en annan version anges den här variabeln till namnet på den utlösande bygg-pipelinen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.TriggeredBy.BuildNumber | Om bygget utlöstes av en annan version anges den här variabeln till antalet utlösande versioner. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Build.TriggeredBy.ProjectID | Om bygget utlöstes av en annan version ställs den här variabeln in på ID för projektet som innehåller den utlösande versionen. I klassiska pipelines utlöses den här variabeln av en utlösare för bygge. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Common.TestResultsDirectory | Den lokala sökvägen på agenten där testresultaten skapas. Exempel: c:\agent_work\1\TestResults . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Pipelinevariabler (DevOps Server 2020)
Olika | beskrivning |
---|---|
Pipeline.Workspace | Arbetsytekatalog för en viss pipeline. Den här variabeln har samma värde som Agent.BuildDirectory . Exempel: /home/vsts/work/1 |
Distributionsjobbvariabler (DevOps Server 2020)
Dessa variabler är begränsade till ett specifikt distributionsjobb och löses endast vid jobbkörning.
Olika | beskrivning |
---|---|
Environment.Name | Namnet på den miljö som distributionsjobbet riktar sig till för att köra distributionsstegen och registrera distributionshistoriken. Exempel: smarthotel-dev |
Environment.Id | ID för den miljö som är mål för distributionsjobbet. Exempel: 10 |
Environment.ResourceName | Namnet på den specifika resursen i den miljö som distributionsjobbet riktar sig till för att köra distributionsstegen och registrera distributionshistoriken. Till exempel, bookings vilket är ett Kubernetes-namnområde som har lagts till som en resurs i miljön smarthotel-dev . |
Environment.ResourceId | ID för den specifika resursen i miljön som är mål för distributionsjobbet för att köra distributionsstegen. Exempel: 4 |
Systemvariabler (DevOps Server 2020)
När du använder en variabel i en mall som inte är markerad som tillgänglig i mallar återges inte variabeln. Variabeln återges inte eftersom dess värde inte är tillgängligt inom mallens omfång.
Olika | beskrivning | Är du tillgänglig i mallar? |
---|---|---|
System.AccessToken | Använd OAuth-token för att komma åt REST-API:et. Använd System.AccessToken från YAML-skript. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.CollectionId | GUID för TFS-samlingen eller Azure DevOps-organisationen | Ja |
System.CollectionUri | En URI för Team Foundation Server-strängsamlingen. | Ja |
System.DefaultWorkingDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Till exempel: c:\agent_work\1\s Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
System.DefinitionId | ID:t för bygg-pipelinen. | Ja |
System.HostType | Ange till build om pipelinen är en version. För en version är deployment värdena för ett distributionsgruppjobb, gates under utvärderingen av portar och release för andra (agent- och agentlösa) jobb. |
Ja |
System.JobAttempt | Ange till 1 första gången det här jobbet görs och ökas varje gång jobbet görs på nytt. | Nej |
System.JobDisplayName | Det människoläsbara namn som ges till ett jobb. | Nej |
System.JobId | En unik identifierare för ett enda jobbförsök. Värdet är unikt för den aktuella pipelinen. | Nej |
System.JobName | Namnet på jobbet, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.PhaseAttempt | Ange till 1 första gången den här fasen görs och ökas varje gång jobbet görs på nytt. Obs! "Fas" är ett mestadels redundant begrepp som representerar designtiden för ett jobb (medan jobbet var körningsversionen av en fas). Vi har mestadels tagit bort begreppet "fas" från Azure Pipelines. Matris- och multikonfigurationsjobb är den enda plats där "fas" fortfarande skiljer sig från "jobb". En fas kan instansiera flera jobb, som bara skiljer sig åt i sina indata. |
Nej |
System.PhaseDisplayName | Det människoläsbara namn som ges till en fas. | Nej |
System.PhaseName | En strängbaserad identifierare för ett jobb, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Nej |
System.StageAttempt | Ange till 1 första gången det här steget görs och ökas varje gång jobbet görs på nytt. | Nej |
System.StageDisplayName | Det människoläsbara namn som ges till ett stadium. | Nej |
System.StageName | En strängbaserad identifierare för en fas, som vanligtvis används för att uttrycka beroenden och komma åt utdatavariabler. | Ja |
System.PullRequest.IsFork | Om pull-begäran kommer från en förgrening av lagringsplatsen är den här variabeln inställd på True . Annars är den inställd på False . |
Ja |
System.PullRequest.PullRequestId | ID för pull-begäran som orsakade den här versionen. Exempel: 17 . (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). |
Nej |
System.PullRequest.PullRequestNumber | Antalet pull-begäranden som orsakade den här versionen. Den här variabeln fylls i för pull-begäranden från GitHub som har ett annat pull-begärande-ID och pull-begärandenummer. Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. | Nej |
System.PullRequest.targetBranchName | Namnet på målgrenen för en pull-begäran. Den här variabeln kan användas i en pipeline för att villkorligt köra uppgifter eller steg baserat på målgrenen för pull-begäran. Du kanske till exempel vill utlösa en annan uppsättning tester eller kodanalysverktyg beroende på den gren som ändringarna sammanfogas till. | Nej |
System.PullRequest.SourceBranch | Grenen som granskas i en pull-begäran. Exempel: refs/heads/users/raisa/new-feature . (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. |
Nej |
System.PullRequest.SourceCommitId | Incheckningen som granskas i en pull-begäran. (Den här variabeln initieras endast om bygget kördes på grund av en Git PR som påverkas av en grenprincip). Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. | |
System.PullRequest.SourceRepositoryURI | URL:en till lagringsplatsen som innehåller pull-begäran. Exempel: https://dev.azure.com/ouraccount/_git/OurProject . |
Nej |
System.PullRequest.TargetBranch | Den gren som är målet för en pull-begäran. Till exempel: refs/heads/main när lagringsplatsen finns i Azure Repos och main när lagringsplatsen finns i GitHub. Den här variabeln initieras endast om bygget kördes på grund av en Git-PR som påverkas av en grenprincip. Den här variabeln är endast tillgänglig i en YAML-pipeline om PR påverkas av en grenprincip. |
Nej |
System.TeamFoundationCollectionUri | URI:n för teamstiftelsens samling. Exempel: https://dev.azure.com/fabrikamfiber/ . Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Ja |
System.TeamProject | Namnet på projektet som innehåller den här versionen. | Ja |
System.TeamProjectId | ID:t för projektet som den här versionen tillhör. | Ja |
TF_BUILD | Ange till True om skriptet körs av en bygguppgift. Den här variabeln är agentomfångad och kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Nej |
Agentvariabler (DevOps Server 2019)
Kommentar
Du kan använda agentvariabler som miljövariabler i skripten och som parametrar i dina bygguppgifter. Du kan inte använda dem för att anpassa versionsnumret eller för att använda en etikett eller tagg för versionskontroll.
Olika | beskrivning |
---|---|
Agent.BuildDirectory | Den lokala sökvägen på agenten där alla mappar för en viss bygg-pipeline skapas. Exempel: c:\agent_work\1 . |
Agent.HomeDirectory | Katalogen som agenten är installerad i. Detta innehåller agentprogramvaran. Exempel: c:\agent . |
Agent.Id | Agentens ID. |
Agent.JobName | Namnet på det jobb som körs. Detta är vanligtvis "Jobb" eller "__default", men i scenarier med flera konfigurationer är konfigurationen. |
Agent.JobStatus | Status för bygget.
AGENT_JOBSTATUS . Den äldre agent.jobstatus är tillgänglig för bakåtkompatibilitet. |
Agent.MachineName | Namnet på den dator där agenten är installerad. |
Agent.Name | Namnet på agenten som är registrerad i poolen. Om du använder en lokalt installerad agent anges det här namnet av dig. Se agenter. |
Agent.OS | Agentvärdens operativsystem. Giltiga värden är:
|
Agent.OSArchitecture | Agentvärdens processorarkitektur för operativsystemet. Giltiga värden är:
|
Agent.TempDirectory | En tillfällig mapp som rensas efter varje pipelinejobb. Den här katalogen används av uppgifter som .NET Core CLI-uppgift för att lagra tillfälliga objekt som testresultat innan de publiceras. |
Agent.ToolsDirectory | Katalogen som används av uppgifter som Installationsprogram för nodverktyg och Använd Python-version för att växla mellan flera versioner av ett verktyg. Dessa uppgifter lägger till verktyg från den här katalogen så PATH att efterföljande byggsteg kan använda dem. Lär dig mer om att hantera den här katalogen på en lokalt installerad agent. |
Agent.WorkFolder | Arbetskatalogen för den här agenten. Exempel: c:\agent_work . Den här katalogen är inte garanterad att vara skrivbar av pipelineaktiviteter (till exempel när den mappas till en container). |
Skapa variabler (DevOps Server 2019)
Olika | beskrivning |
---|---|
Build.ArtifactStagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a . Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.BuildId | ID:t för posten för den slutförda versionen. |
Build.BuildNumber | Namnet på den färdiga versionen. Du kan ange det versionsnummerformat som genererar det här värdet i pipelinealternativen. En vanlig användning av den här variabeln är att göra den till en del av etikettformatet, som du anger på fliken lagringsplats. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.BuildUri | URI:n för bygget. Exempel: vstfs:///Build/Build/1430 . Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.BinariesDirectory | Den lokala sökvägen på agenten som du kan använda som utdatamapp för kompilerade binärfiler. Som standard konfigureras inte nya byggpipelines för att rensa den här katalogen. Du kan definiera din version för att rensa den på fliken Lagringsplats. Exempel: c:\agent_work\1\b . Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.DefinitionName | Namnet på bygg-pipeline. Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Build.DefinitionVersion | Versionen av bygg-pipelinen. |
Build.QueuedBy | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Build.QueuedById | Se "Hur anges identitetsvariablerna?". |
Build.Reason | Händelsen som gjorde att bygget kördes.
|
Build.Repository.Clean | Värdet som du har valt för Rensa i källlagringsplatsens inställningar. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.Repository.LocalPath | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Till exempel: c:\agent_work\1\s Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Den här variabeln är synonym med Build.SourcesDirectory. |
Build.Repository.Name | Namnet på lagringsplatsen. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.Repository.Provider | Den typ av lagringsplats som du har valt.
|
Build.Repository.Tfvc.Workspace | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Namnet på TFVC-arbetsytan som används av byggagenten. Om till exempel Agent.BuildDirectory är c:\agent_work\12 och Agent.Id är 8 kan arbetsytans namn vara: ws_12_8 . Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.Repository.Uri | URL:en för lagringsplatsen. Till exempel: Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.RequestedFor | Se "Hur anges identitetsvariablerna?". Obs! Det här värdet kan innehålla blanksteg eller andra ogiltiga etiketttecken. I dessa fall misslyckas etikettformatet . |
Build.RequestedForEmail | Se "Hur anges identitetsvariablerna?". |
Build.RequestedForId | Se "Hur anges identitetsvariablerna?". |
Build.SourceBranch | Den gren som bygget stod i kö för. Några exempel:
/ ) med understreckstecken (_ ). Obs! Om du kör en gated check-in-version i TFVC eller skapar en hylloruppsättning manuellt kan du inte använda den här variabeln i ditt versionsnummerformat. |
Build.SourceBranchName | Namnet på den gren som bygget stod i kö för.
|
Build.SourcesDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Exempel: c:\agent_work\1\s .Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Den här variabeln är synonym med Build.Repository.LocalPath. |
Build.SourceVersion | Den senaste versionskontrolländringen som ingår i den här versionen. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.SourceVersionMessage | Kommentaren för incheckningen eller ändringsuppsättningen. Vi trunkerar meddelandet till den första raden eller 200 tecken, beroende på vilket som är kortare. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. Obs! Den här variabeln är tillgänglig i TFS 2015.4. Obs! Variabeln Build.SourceVersionMessage fungerar inte med klassiska byggpipelines i Bitbucket-lagringsplatser när Batch ändras medan en version pågår är aktiverad. |
Build.StagingDirectory | Den lokala sökvägen på agenten där artefakter kopieras till innan de skickas till målet. Exempel: c:\agent_work\1\a . Ett vanligt sätt att använda den här mappen är att publicera dina byggartefakter med uppgifterna Kopiera filer och Publicera byggartefakter . Obs! Build.ArtifactStagingDirectory och Build.StagingDirectory är utbytbara. Den här katalogen rensas före varje ny version, så du behöver inte rensa den själv. Se Artefakter i Azure Pipelines. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.Repository.Git.SubmoduleCheckout | Det värde som du har valt för Checkout-undermoduler på fliken lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.SourceTfvcShelveset | Definierad om lagringsplatsen är Versionskontroll för Team Foundation. Om du kör en gated build eller en hyllor bygge, detta är inställt på namnet på den hyllor du bygger. Obs! Den här variabeln ger ett ogiltigt värde för bygganvändning i ett versionsnummerformat. |
Build.TriggeredBy.BuildId | Om bygget utlöstes av en annan version ställs den här variabeln in på BuildID för den utlösande versionen. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.TriggeredBy.DefinitionId | Om bygget utlöstes av en annan version anges den här variabeln till DefinitionID för den utlösande versionen. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.TriggeredBy.DefinitionName | Om bygget utlöstes av en annan version anges den här variabeln till namnet på den utlösande bygg-pipelinen. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.TriggeredBy.BuildNumber | Om bygget utlöstes av en annan version anges den här variabeln till antalet utlösande versioner. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Build.TriggeredBy.ProjectID | Om bygget utlöstes av en annan version ställs den här variabeln in på ID för projektet som innehåller den utlösande versionen. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Common.TestResultsDirectory | Den lokala sökvägen på agenten där testresultaten skapas. Exempel: c:\agent_work\1\TestResults . Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Systemvariabler (DevOps Server 2019)
Exempel på PowerShell-skript: åtkomst till REST API
Olika | beskrivning |
---|---|
System.AccessToken | Använd OAuth-token för att komma åt REST-API:et. Använd System.AccessToken från YAML-skript. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
System.CollectionId | GUID för TFS-samlingen eller Azure DevOps-organisationen |
System.DefaultWorkingDirectory | Den lokala sökvägen till agenten där dina källkodsfiler laddas ned. Till exempel: c:\agent_work\1\s Som standard uppdaterar nya bygg-pipelines endast de ändrade filerna. Du kan ändra hur filer laddas ned på fliken Lagringsplats. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
System.DefinitionId | ID:t för bygg-pipelinen. |
System.HostType | Ange till build om pipelinen är en version. För en version är deployment värdena för ett distributionsgruppsjobb och release för ett agentjobb. |
System.PullRequest.IsFork | Om pull-begäran kommer från en förgrening av lagringsplatsen är den här variabeln inställd på True . Annars är den inställd på False . |
System.PullRequest.PullRequestId | ID för pull-begäran som orsakade den här versionen. Exempel: 17 . (Den här variabeln initieras endast om bygget kördes på grund av en Git PR påverkas av en grenprincip.) |
System.PullRequest.PullRequestNumber | Antalet pull-begäranden som orsakade den här versionen. Den här variabeln fylls i för pull-begäranden från GitHub, som har ett annat pull-begärande-ID och pull-begärandenummer. |
System.PullRequest.SourceBranch | Grenen som granskas i en pull-begäran. Exempel: refs/heads/users/raisa/new-feature . (Den här variabeln initieras endast om bygget kördes på grund av en Git PR påverkas av en grenprincip.) |
System.PullRequest.SourceCommitId | Incheckningen som granskas i en pull-begäran. (Den här variabeln initieras endast om bygget kördes på grund av en Git PR påverkas av en grenprincip.) |
System.PullRequest.SourceRepositoryURI | URL:en till lagringsplatsen som innehåller pull-begäran. Exempel: https://dev.azure.com/ouraccount/_git/OurProject . (Den här variabeln initieras endast om bygget kördes på grund av en Azure Repos Git PR påverkas av en grenprincip. Den initieras inte för GitHub-PR:er.) |
System.PullRequest.TargetBranch | Den gren som är målet för en pull-begäran. Exempel: refs/heads/main . Den här variabeln initieras endast om bygget kördes på grund av en Git-PR som påverkas av en grenprincip. |
System.TeamFoundationCollectionUri | URI:n för teamstiftelsens samling. Exempel: https://dev.azure.com/fabrikamfiber/ . Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
System.TeamProject | Namnet på projektet som innehåller den här versionen. |
System.TeamProjectId | ID:t för projektet som den här versionen tillhör. |
TF_BUILD | Ange till True om skriptet körs av en bygguppgift. Den här variabeln är agentomfattning. Den kan användas som en miljövariabel i ett skript och som en parameter i en bygguppgift, men inte som en del av versionsnumret eller som en versionskontrolltagg. |
Hur anges identitetsvariablerna?
Värdet beror på vad som orsakade bygget och är specifikt för Azure Repos-lagringsplatser.
Om bygget utlöses... | Sedan baseras värdena Build.QueuedBy och Build.QueuedById på... | Värdena Build.RequestedFor och Build.RequestedForId baseras sedan på... |
---|---|---|
I Git eller av CI-utlösare (Continuous Integration) | Systemidentiteten, till exempel: [DefaultCollection]\Project Collection Service Accounts |
Den person som push-överförde eller checkade in ändringarna. |
I Git eller av en grenprincipversion. | Systemidentiteten, till exempel: [DefaultCollection]\Project Collection Service Accounts |
Den person som checkade in ändringarna. |
I TFVC med en gated incheckningsutlösare | Den person som checkade in ändringarna. | Den person som checkade in ändringarna. |
I Git eller TFVC efter schemalagda utlösare | Systemidentiteten, till exempel: [DefaultCollection]\Project Collection Service Accounts |
Systemidentiteten, till exempel: [DefaultCollection]\Project Collection Service Accounts |
Eftersom du klickade på knappen Köbygge | Du | Du |