Použití předdefinovaných proměnných
Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019
Proměnné vám poskytují pohodlný způsob, jak získat klíčové bity dat do různých částí vašeho kanálu. Toto je seznam předdefinovaných proměnných, které jsou k dispozici pro vaše použití. Může existovat několik dalších předdefinovaných proměnných, ale většinou se používají pro interní použití.
Tyto proměnné jsou automaticky nastaveny systémem a jen pro čtení. (Výjimky jsou Build.Clean a System.Debug.)
V kanálech YAML můžete odkazovat na předdefinované proměnné jako proměnné prostředí. Proměnná Build.ArtifactStagingDirectory
se například stane proměnnou BUILD_ARTIFACTSTAGINGDIRECTORY
.
U klasických kanálů můžete pomocí proměnných vydaných verzí v úlohách nasazení sdílet společné informace (například název prostředí, skupina prostředků atd.).
Přečtěte si další informace o práci s proměnnými.
Build.Clean
Jedná se o zastaralou proměnnou, která upravuje způsob čištění zdroje agentem sestavení. Informace o vyčištění zdroje najdete v tématu Vyčištění místního úložiště agenta.
System.AccessToken
System.AccessToken
je speciální proměnná, která nese token zabezpečení používaný spuštěným sestavením.
V YAML musíte explicitně namapovat System.AccessToken
do kanálu pomocí proměnné. Můžete to udělat na úrovni kroku nebo úkolu:
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)
Můžete nakonfigurovat výchozí obor pro System.AccessToken
použití oboru autorizace úlohy sestavení.
System.Debug
Podrobnější protokoly pro ladění problémů s kanálem definujte System.Debug
a nastavte na true
.
Upravte kanál.
Vyberte Proměnné.
Přidejte novou proměnnou s názvem
System.Debug
a hodnotoutrue
.Uložte novou proměnnou.
Nastavení System.Debug
pro true
konfiguraci podrobných protokolů pro všechna spuštění Podrobné protokoly můžete také nakonfigurovat pro jedno spuštění pomocí zaškrtávacího políčka Povolit diagnostiku systému.
Můžete také nastavit System.Debug
true
jako proměnnou v kanálu nebo šabloně.
variables:
system.debug: 'true'
Pokud System.Debug
je nastavena na true
hodnotu , je true
nastavena další proměnná s názvem Agent.Diagnostic
. Pokud Agent.Diagnostic
je tomu true
tak, agent shromažďuje další protokoly, které je možné použít k řešení potíží se sítí pro agenty v místním prostředí. Další informace najdete v tématu Diagnostika sítě pro agenty v místním prostředí.
Poznámka:
Proměnná Agent.Diagnostic
je k dispozici s agentem v2.200.0 a novějším.
Další informace najdete v tématu Kontrola protokolů pro diagnostiku problémů s kanály.
Proměnné agenta (DevOps Services)
Poznámka:
Proměnné agenta můžete použít jako proměnné prostředí ve skriptech a jako parametry v úlohách sestavení. Nemůžete je použít k přizpůsobení čísla buildu nebo k použití popisku nebo značky správy verzí.
Proměnná | Popis |
---|---|
Agent.BuildDirectory | Místní cesta k agentu, kde se vytvoří všechny složky pro daný kanál buildu. Tato proměnná má stejnou hodnotu jako Pipeline.Workspace . Například: /home/vsts/work/1 . |
Agent.ContainerMapping | Mapování z názvů prostředků kontejneru v YAML na jejich ID Dockeru za běhu Příklad následuje po tabulce. |
Agent.HomeDirectory | Adresář, do který je agent nainstalovaný. Obsahuje software agenta. Například: c:\agent . |
Agent.Id | ID agenta. |
Agent.JobName | Název spuštěné úlohy. Obvykle to bude "Job"; nebo "__default", ale ve scénářích s více konfiguracemi bude konfigurace. |
Agent.JobStatus | Stav sestavení.
AGENT_JOBSTATUS . agent.jobstatus Starší verze je k dispozici pro zpětnou kompatibilitu. |
Agent.MachineName | Název počítače, na kterém je agent nainstalovaný. |
Agent.Name | Název agenta zaregistrovaného ve fondu. Pokud používáte agenta v místním prostředí, je tento název určen vámi. Podívejte se na agenty. |
Agent.OS | Operační systém hostitele agenta. Platné hodnoty jsou:
|
Agent.OSArchitecture | Architektura procesoru operačního systému hostitele agenta. Platné hodnoty jsou:
|
Agent.TempDirectory | Dočasná složka, která se vyčistí po každé úloze kanálu. Tento adresář používají úlohy, jako je úloha rozhraní příkazového řádku .NET Core, k uložení dočasných položek, jako jsou výsledky testů před jejich publikováním. Příklad: /home/vsts/work/_temp pro Ubuntu. |
Agent.ToolsDirectory | Adresář používaný úlohami, jako je instalační program nástroje Node Tool, a použít verzi Pythonu k přepínání mezi několika verzemi nástroje. Tyto úlohy přidávají nástroje z tohoto adresáře, PATH aby je mohly použít následné kroky sestavení.Přečtěte si o správě tohoto adresáře v místním agentu. |
Agent.WorkFolder | Pracovní adresář pro tohoto agenta. Například: c:\agent_work .Poznámka: U tohoto adresáře není zaručeno, že je možné zapisovat úkoly kanálu (například při mapování do kontejneru). |
Příklad agenta.ContainerMapping:
{
"one_container": {
"id": "bdbb357d73a0bd3550a1a5b778b62a4c88ed2051c7802a0659f1ff6e76910190"
},
"another_container": {
"id": "82652975109ec494876a8ccbb875459c945982952e0a72ad74c91216707162bb"
}
}
Vytváření proměnných (DevOps Services)
Pokud použijete proměnnou v šabloně, která není v šablonách označená jako dostupná, proměnná se nevykreslí. Proměnná se nevykreslí, protože její hodnota není přístupná v rámci oboru šablony.
Proměnná | Popis | K dispozici v šablonách? |
---|---|---|
Build.ArtifactStagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a .Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BuildId | ID záznamu pro dokončené sestavení. | No |
Build.BuildNumber | Název dokončeného sestavení, označovaný také jako číslo spuštění. Můžete zadat , co je součástí této hodnoty. Typickým použitím této proměnné je, aby byla součástí formátu popisku, který zadáte na kartě úložiště. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BuildUri | Identifikátor URI sestavení. Například: vstfs:///Build/Build/1430 .Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BinariesDirectory | Místní cesta k agentu, kterou můžete použít jako výstupní složku pro kompilované binární soubory. Ve výchozím nastavení nejsou nové kanály buildu nastavené pro vyčištění tohoto adresáře. Sestavení můžete definovat a vyčistit ho na kartě Úložiště. Například: c:\agent_work\1\b .Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.ContainerId | ID kontejneru pro váš artefakt. Když do kanálu nahrajete artefakt, přidá se do kontejneru, který je specifický pro daný artefakt. | No |
Build.CronSchedule.DisplayName | Plán displayName cron, který aktivoval spuštění kanálu. Tato proměnná je nastavená pouze v případě, že spuštění kanálu aktivuje naplánovaná aktivační událost YAML. Další informace najdete v tématu schedules.cron definition - Build.CronSchedule.DisplayName variable |
Ano |
Build.DefinitionName | Název kanálu buildu. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.DefinitionVersion | Verze kanálu buildu. | Ano |
Build.QueuedBy | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.QueuedById | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.Reason | Událost, která způsobila spuštění sestavení.
|
Ano |
Build.Repository.Clean | Hodnota, kterou jste vybrali pro vyčištění v nastavení zdrojového úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.LocalPath | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s .Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Důležitá poznámka: Pokud si prohlédnete jenom jedno úložiště Git, je tato cesta přesnou cestou ke kódu. Pokud si prohlédnete více úložišť, chování je následující (a může se lišit od hodnoty proměnné Build.SourcesDirectory):
|
No |
Build.Repository.ID | Jedinečný identifikátor úložiště. To se nezmění, i když se název úložiště změní. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Name | Název aktivačního úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Provider | Typ aktivovaného úložiště.
|
No |
Build.Repository.Tfvc.Workspace | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Název pracovního prostoru TFVC, který používá agent sestavení. Pokud je c:\agent_work\12 například Agent.BuildDirectory a Agent.Id je 8 , název pracovního prostoru může být: ws_12_8 Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Uri | Adresa URL pro aktivované úložiště. Příklad: Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.RequestedFor | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.RequestedForEmail | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.RequestedForId | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.SourceBranch | Větev aktivačního úložiště, pro které bylo sestavení zařazeno do fronty. Některé příklady:
/ ) se nahradí podtržítkem _ ).Poznámka: Pokud v TFVC spouštíte vrátný build check-in nebo ručně vytváříte sadu odložených položek, nemůžete tuto proměnnou použít ve formátu čísla buildu. |
Ano |
Build.SourceBranchName | Název větve v aktivačním úložišti, pro které bylo sestavení zařazeno do fronty.
|
Ano |
Build.SourcesDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s .Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Důležitá poznámka: Pokud si prohlédnete jenom jedno úložiště Git, je tato cesta přesnou cestou ke kódu. Pokud si prohlédnete více úložišť, vrátí se k výchozí hodnotě, což je $(Pipeline.Workspace)/s , i když je vlastní (primární) úložiště rezervováno na vlastní cestu, která se liší od výchozí cesty $(Pipeline.Workspace)/s/<RepoName> s více rezervacemi (v tomto ohledu se proměnná liší od chování proměnné Build.Repository.LocalPath).Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.SourceVersion | Nejnovější změna správy verzí aktivačního úložiště, které je součástí tohoto buildu.
|
Ano |
Build.SourceVersionMessage | Komentář k potvrzení nebo sadě změn pro aktivační úložiště. Zprávu zkrátíme na první řádek nebo 200 znaků podle toho, co je kratší. Odpovídá Build.SourceVersionMessage zprávě při Build.SourceVersion potvrzení. Potvrzení Build.SourceVersion sestavení žádosti o přijetí změn je potvrzení sloučení (nikoli potvrzení ve zdrojové větvi).Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Tato proměnná je k dispozici pouze na úrovni kroku a není k dispozici v úrovních úlohy nebo fáze (to znamená, že zpráva se extrahuje, dokud se úloha nespustí a kód je rezervován). Poznámka: Tato proměnná je k dispozici v TFS 2015.4. Poznámka: Proměnná Build.SourceVersionMessage nefunguje s klasickými kanály buildu v úložištích Bitbucket, když je povolená služba Batch, zatímco probíhá sestavení. |
No |
Build.StagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a .Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Git.SubmoduleCheckout | Hodnota, kterou jste vybrali pro dílčí režimy rezervace na kartě úložiště. U rezervovaných více úložišť tato hodnota sleduje nastavení aktivujícího úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.SourceTfvcShelveset | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Pokud používáte vrátný build nebo build sady odložených odložených razítek, nastaví se na název sady odlic, kterou vytváříte. Poznámka: Tato proměnná poskytuje hodnotu, která je neplatná pro použití sestavení ve formátu čísla sestavení. |
No |
Build.TriggeredBy.BuildId | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na BuildID aktivačního sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.DefinitionId | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na DefinitionID aktivačního sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.DefinitionName | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na název aktivačního kanálu sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.BuildNumber | Pokud se sestavení aktivovalo jiným sestavením, nastaví se tato proměnná na počet aktivačních sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.ProjectID | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na ID projektu, který obsahuje aktivační sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Common.TestResultsDirectory | Místní cesta k agentu, kde se vytvoří výsledky testu. Například: c:\agent_work\1\TestResults .Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Proměnné kanálu (DevOps Services)
Proměnná | Popis |
---|---|
Pipeline.Workspace | Adresář pracovního prostoru pro konkrétní kanál Tato proměnná má stejnou hodnotu jako Agent.BuildDirectory . Například /home/vsts/work/1 . |
Tip
Pokud používáte klasické kanály verze, můžete použít klasické verze a proměnné artefaktů k ukládání a přístupu k datům v celém kanálu.
Proměnné úlohy nasazení (DevOps Services)
Tyto proměnné jsou vymezeny na konkrétní úlohu nasazení a budou vyřešeny pouze v době provádění úlohy.
Proměnná | Popis |
---|---|
Environment.Name | Název prostředí cíleného na úlohu nasazení pro spuštění kroků nasazení a zaznamenání historie nasazení. Například smarthotel-dev . |
Environment.Id | ID prostředí určeného v úloze nasazení. Například 10 . |
Environment.ResourceName | Název konkrétního prostředku v prostředí určeném v úloze nasazení pro spuštění kroků nasazení a zaznamenání historie nasazení. Jedná se například bookings o obor názvů Kubernetes, který byl přidán jako prostředek do prostředí smarthotel-dev . |
Environment.ResourceId | ID konkrétního prostředku v rámci prostředí určeného v úloze nasazení pro spuštění kroků nasazení. Například 4 . |
Strategy.Name | Název strategie nasazení: canary , runOnce nebo rolling . |
Strategy.CycleName | Název aktuálního cyklu v nasazení Možnosti jsou PreIteration , Iteration nebo PostIteration . |
Systémové proměnné (DevOps Services)
Pokud použijete proměnnou v šabloně, která není v šablonách označená jako dostupná, proměnná se nevykreslí. Proměnná se nevykreslí, protože její hodnota není přístupná v rámci oboru šablony.
Proměnná | Popis | K dispozici v šablonách? |
---|---|---|
System.AccessToken | Pro přístup k rozhraní REST API použijte token OAuth. Použijte System.AccessToken ze skriptů YAML. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.CollectionId | Identifikátor GUID kolekce TFS nebo organizace Azure DevOps. | Ano |
System.CollectionUri | Identifikátor URI kolekce TFS nebo organizace Azure DevOps. Například: https://dev.azure.com/fabrikamfiber/ . |
Ano |
System.DefaultWorkingDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Příklad: c:\agent_work\1\s Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.DefinitionId | ID kanálu buildu. | Ano |
System.HostType | Nastavte, build jestli je kanál buildem. Pro vydání jsou deployment hodnoty pro úlohu skupiny nasazení, gates během vyhodnocení bran a release pro další úlohy (agent a bez agentů). |
Ano |
System.JobAttempt | Při prvním pokusu o tuto úlohu nastavíte na 1 a při každém opakování úlohy se zvýší. | No |
System.JobDisplayName | Jméno člověka čitelného pro práci. | No |
System.JobId | Jedinečný identifikátor jednoho pokusu o jednu úlohu. Hodnota je jedinečná pro aktuální kanál. | No |
System.JobName | Název úlohy, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.OidcRequestUri | idToken Vygenerujte ověřování pomocí ID Entra pomocí OpenID Connect (OIDC). Další informace. |
Ano |
System.PhaseAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování úlohy se zvýší. Poznámka: Fáze je převážně redundantní koncept, který představuje dobu návrhu úlohy (zatímco úloha byla verzí modulu runtime fáze). Z Azure Pipelines jsme většinou odebrali koncept fáze. Matice a úlohy s více konfiguracemi jsou jediným místem, kde se "fáze" stále liší od úlohy. Jedna fáze může vytvořit instanci více úloh, které se liší pouze v jejich vstupech. |
No |
System.PhaseDisplayName | Lidsky čitelný název zadaný fázi. | No |
System.PhaseName | Identifikátor založený na řetězci pro úlohu, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.PlanId | Identifikátor založený na řetězci pro jedno spuštění kanálu. | No |
System.PullRequest.IsFork | Pokud žádost o přijetí změn pochází z forku úložiště, je tato proměnná nastavená na True hodnotu .V opačném případě je nastavená na False hodnotu . |
Ano |
System.PullRequest.PullRequestId | ID žádosti o přijetí změn, která způsobila toto sestavení. Například: 17 . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) |
No |
System.PullRequest.PullRequestNumber | Počet žádostí o přijetí změn, které způsobily toto sestavení Tato proměnná se vyplní pro žádosti o přijetí změn z GitHubu, které mají jiné ID žádosti o přijetí změn a číslo žádosti o přijetí změn. Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. | No |
System.PullRequest.targetBranchName | Název cílové větve žádosti o přijetí změn Tuto proměnnou lze použít v kanálu k podmíněnému spouštění úloh nebo kroků na základě cílové větve žádosti o přijetí změn. Můžete například chtít aktivovat jinou sadu testů nebo nástrojů pro analýzu kódu v závislosti na větvi, do které se změny slučují. | No |
System.PullRequest.SourceBranch | Větev, která se kontroluje v žádosti o přijetí změn Příklad: refs/heads/users/raisa/new-feature pro Azure Repos. (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. |
No |
System.PullRequest.SourceCommitId | Potvrzení, které se kontroluje v žádosti o přijetí změn. (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. | |
System.PullRequest.SourceRepositoryURI | Adresa URL úložiště, které obsahuje žádost o přijetí změn. Například: https://dev.azure.com/ouraccount/_git/OurProject . |
No |
System.PullRequest.TargetBranch | Větev, která je cílem žádosti o přijetí změn. Příklad: refs/heads/main Když je úložiště v Azure Repos a main kdy je vaše úložiště na GitHubu. Tato proměnná se inicializuje jenom v případě, že se sestavení spustilo kvůli zásadám větve ovlivněné žádostmi o přijetí změn Gitu. Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. |
No |
System.StageAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování úlohy se zvýší. | No |
System.StageDisplayName | Název, který je čitelný pro člověka, který je dán do fáze. | No |
System.StageName | Identifikátor založený na řetězci pro fázi, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.TeamFoundationCollectionUri | Identifikátor URI kolekce TFS nebo organizace Azure DevOps. Například: https://dev.azure.com/fabrikamfiber/ .Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.TeamProject | Název projektu, který obsahuje toto sestavení. | Ano |
System.TeamProjectId | ID projektu, do kterého tento build patří. | Ano |
System.TimelineId | Identifikátor založený na řetězci pro podrobnosti spuštění a protokoly jednoho spuštění kanálu. | No |
TF_BUILD | Nastavte, True jestli skript spouští úloha sestavení.Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Kontroluje proměnné (DevOps Services)
Proměnná | Popis |
---|---|
Checks.StageAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování fáze se zvýší. Tuto proměnnou lze použít pouze ve schválení nebo kontrolovat prostředí. Můžete například použít $(Checks.StageAttempt) v rámci kontroly rozhraní REST API vyvolání. |
Proměnné agenta (DevOps Server 2022)
Poznámka:
Proměnné agenta můžete použít jako proměnné prostředí ve skriptech a jako parametry v úlohách sestavení. Nemůžete je použít k přizpůsobení čísla buildu nebo k použití popisku nebo značky správy verzí.
Proměnná | Popis |
---|---|
Agent.BuildDirectory | Místní cesta k agentu, kde se vytvoří všechny složky pro daný kanál buildu. Tato proměnná má stejnou hodnotu jako Pipeline.Workspace . Například: /home/vsts/work/1 . |
Agent.ContainerMapping | Mapování z názvů prostředků kontejneru v YAML na jejich ID Dockeru za běhu Příklad následuje po tabulce. |
Agent.HomeDirectory | Adresář, do který je agent nainstalovaný. Obsahuje software agenta. Například: c:\agent . |
Agent.Id | ID agenta. |
Agent.JobName | Název spuštěné úlohy. Obvykle se jedná o úlohu nebo __default, ale ve scénářích s více konfiguracemi bude konfigurace. |
Agent.JobStatus | Stav sestavení.
AGENT_JOBSTATUS . agent.jobstatus Starší verze je k dispozici pro zpětnou kompatibilitu. |
Agent.MachineName | Název počítače, na kterém je agent nainstalovaný. |
Agent.Name | Název agenta zaregistrovaného ve fondu. Pokud používáte agenta v místním prostředí, je tento název určen vámi. Podívejte se na agenty. |
Agent.OS | Operační systém hostitele agenta. Platné hodnoty jsou:
|
Agent.OSArchitecture | Architektura procesoru operačního systému hostitele agenta. Platné hodnoty jsou:
|
Agent.TempDirectory | Dočasná složka, která se vyčistí po každé úloze kanálu. Tento adresář používají úlohy, jako je úloha rozhraní příkazového řádku .NET Core, k uložení dočasných položek, jako jsou výsledky testů před jejich publikováním. Příklad: /home/vsts/work/_temp pro Ubuntu. |
Agent.ToolsDirectory | Adresář používaný úlohami, jako je instalační program nástroje Node Tool, a použít verzi Pythonu k přepínání mezi několika verzemi nástroje. Tyto úlohy přidávají nástroje z tohoto adresáře, PATH aby je mohly použít následné kroky sestavení.Přečtěte si o správě tohoto adresáře v místním agentu. |
Agent.WorkFolder | Pracovní adresář pro tohoto agenta. Například: c:\agent_work .Poznámka: U tohoto adresáře není zaručeno, že je možné zapisovat úkoly kanálu (například při mapování do kontejneru). |
Příklad agenta.ContainerMapping:
{
"one_container": {
"id": "bdbb357d73a0bd3550a1a5b778b62a4c88ed2051c7802a0659f1ff6e76910190"
},
"another_container": {
"id": "82652975109ec494876a8ccbb875459c945982952e0a72ad74c91216707162bb"
}
}
Sestavení proměnných (DevOps Server 2022)
Pokud použijete proměnnou v šabloně, která není v šablonách označená jako dostupná, proměnná se nevykreslí. Proměnná se nevykreslí, protože její hodnota není přístupná v rámci oboru šablony.
Proměnná | Popis | K dispozici v šablonách? |
---|---|---|
Build.ArtifactStagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a . Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BuildId | ID záznamu pro dokončené sestavení. | No |
Build.BuildNumber | Název dokončeného sestavení, označovaný také jako číslo spuštění. Můžete zadat , co je součástí této hodnoty. Typickým použitím této proměnné je, aby byla součástí formátu popisku, který zadáte na kartě úložiště. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BuildUri | Identifikátor URI sestavení. Například: vstfs:///Build/Build/1430 . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BinariesDirectory | Místní cesta k agentu, kterou můžete použít jako výstupní složku pro kompilované binární soubory. Ve výchozím nastavení nejsou nové kanály buildu nastavené pro vyčištění tohoto adresáře. Sestavení můžete definovat a vyčistit ho na kartě Úložiště. Například: c:\agent_work\1\b . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.ContainerId | ID kontejneru pro váš artefakt. Když do kanálu nahrajete artefakt, přidá se do kontejneru, který je specifický pro daný artefakt. | No |
Build.CronSchedule.DisplayName | Plán displayName cron, který aktivoval spuštění kanálu. Tato proměnná je nastavená pouze v případě, že spuštění kanálu aktivuje naplánovaná aktivační událost YAML. Další informace naleznete v tématu schedules.cron definition - Build.CronSchedule.DisplayName variable. Tato proměnná je dostupná v Azure DevOps Serveru 2022.1 a novějším. |
Ano |
Build.DefinitionName | Název kanálu buildu. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.DefinitionVersion | Verze kanálu buildu. | Ano |
Build.QueuedBy | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.QueuedById | Přečtěte si téma "Jak jsou nastavené proměnné identity?. | Ano |
Build.Reason | Událost, která způsobila spuštění sestavení.
|
Ano |
Build.Repository.Clean | Hodnota, kterou jste vybrali pro vyčištění v nastavení zdrojového úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.LocalPath | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s . Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Důležitá poznámka: Pokud si prohlédnete jenom jedno úložiště Git, je tato cesta přesnou cestou ke kódu. Pokud si prohlédnete více úložišť, chování je následující (a může se lišit od hodnoty proměnné Build.SourcesDirectory):
|
No |
Build.Repository.ID | Jedinečný identifikátor úložiště. To se nezmění, i když se název úložiště změní. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Name | Název aktivačního úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Provider | Typ aktivovaného úložiště.
|
No |
Build.Repository.Tfvc.Workspace | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Název pracovního prostoru TFVC, který používá agent sestavení. Pokud je c:\agent_work\12 například Agent.BuildDirectory a Agent.Id je 8 , název pracovního prostoru může být: ws_12_8 .Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Uri | Adresa URL pro aktivované úložiště. Příklad:Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. | No |
Build.RequestedFor | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.RequestedForEmail | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.RequestedForId | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.SourceBranch | Větev aktivačního úložiště, pro které bylo sestavení zařazeno do fronty. Některé příklady:
/ ) se nahradí podtržítkem _ ).Poznámka: Pokud v TFVC spouštíte vrátný build check-in nebo ručně vytváříte sadu odložených položek, nemůžete tuto proměnnou použít ve formátu čísla buildu. |
Ano |
Build.SourceBranchName | Název větve v aktivačním úložišti, pro které bylo sestavení zařazeno do fronty.
|
Ano |
Build.SourcesDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s . Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Důležitá poznámka: Pokud si prohlédnete jenom jedno úložiště Git, je tato cesta přesnou cestou ke kódu. Pokud si prohlédnete více úložišť, vrátí se k výchozí hodnotě, což je $(Pipeline.Workspace)/s , i když je vlastní (primární) úložiště rezervováno na vlastní cestu, která se liší od výchozí cesty $(Pipeline.Workspace)/s/<RepoName> s více rezervacemi (v tomto ohledu se proměnná liší od chování proměnné Build.Repository.LocalPath).Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.SourceVersion | Nejnovější změna správy verzí aktivačního úložiště, které je součástí tohoto buildu.
|
Ano |
Build.SourceVersionMessage | Komentář k potvrzení nebo sadě změn pro aktivační úložiště. Zprávu zkrátíme na první řádek nebo 200 znaků podle toho, co je kratší. Odpovídá Build.SourceVersionMessage zprávě při Build.SourceVersion potvrzení. Potvrzení Build.SourceVersion sestavení žádosti o přijetí změn je potvrzení sloučení (nikoli potvrzení ve zdrojové větvi). Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Tato proměnná je k dispozici pouze na úrovni kroku a není k dispozici v úrovních úlohy nebo fáze (to znamená, že zpráva se extrahuje, dokud se úloha nespustí a kód je rezervován). Poznámka: Tato proměnná je k dispozici v TFS 2015.4. Poznámka: Proměnná Build.SourceVersionMessage nefunguje s klasickými kanály buildu v úložištích Bitbucket, když je povolená služba Batch, zatímco probíhá sestavení. |
No |
Build.StagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a . Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Git.SubmoduleCheckout | Hodnota, kterou jste vybrali pro dílčí režimy rezervace na kartě úložiště. U rezervovaných více úložišť tato hodnota sleduje nastavení aktivujícího úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.SourceTfvcShelveset | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Pokud používáte vrátný build nebo build sady odložených odložených razítek, nastaví se na název sady odlic, kterou vytváříte. Poznámka: Tato proměnná poskytuje hodnotu, která je neplatná pro použití sestavení ve formátu čísla sestavení. |
No |
Build.TriggeredBy.BuildId | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na BuildID aktivačního sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.DefinitionId | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na DefinitionID aktivačního sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.DefinitionName | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na název aktivačního kanálu sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.BuildNumber | Pokud se sestavení aktivovalo jiným sestavením, nastaví se tato proměnná na počet aktivačních sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Build.TriggeredBy.ProjectID | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na ID projektu, který obsahuje aktivační sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Pokud spouštíte kanál YAML pomocí resources , měli byste místo toho použít proměnné prostředků. |
No |
Common.TestResultsDirectory | Místní cesta k agentu, kde se vytvoří výsledky testu. Například: c:\agent_work\1\TestResults . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Proměnné kanálu (DevOps Server 2022)
Proměnná | Popis |
---|---|
Pipeline.Workspace | Adresář pracovního prostoru pro konkrétní kanál Tato proměnná má stejnou hodnotu jako Agent.BuildDirectory . Například /home/vsts/work/1 . |
Tip
Pokud používáte klasické kanály verze, můžete použít klasické verze a proměnné artefaktů k ukládání a přístupu k datům v celém kanálu.
Proměnné úlohy nasazení (DevOps Server 2022)
Tyto proměnné jsou vymezeny na konkrétní úlohu nasazení a budou vyřešeny pouze v době provádění úlohy.
Proměnná | Popis |
---|---|
Environment.Name | Název prostředí cíleného na úlohu nasazení pro spuštění kroků nasazení a zaznamenání historie nasazení. Například smarthotel-dev . |
Environment.Id | ID prostředí určeného v úloze nasazení. Například 10 . |
Environment.ResourceName | Název konkrétního prostředku v prostředí určeném v úloze nasazení pro spuštění kroků nasazení a zaznamenání historie nasazení. Jedná se například bookings o obor názvů Kubernetes, který byl přidán jako prostředek do prostředí smarthotel-dev . |
Environment.ResourceId | ID konkrétního prostředku v rámci prostředí určeného v úloze nasazení pro spuštění kroků nasazení. Například 4 . |
Strategy.Name | Název strategie nasazení: canary , runOnce nebo rolling . |
Strategy.CycleName | Název aktuálního cyklu v nasazení Možnosti jsou PreIteration , Iteration nebo PostIteration . |
Systémové proměnné (DevOps Server 2022)
Pokud použijete proměnnou v šabloně, která není v šablonách označená jako dostupná, proměnná se nevykreslí. Proměnná se nevykreslí, protože její hodnota není přístupná v rámci oboru šablony.
Proměnná | Popis | K dispozici v šablonách? |
---|---|---|
System.AccessToken | Pro přístup k rozhraní REST API použijte token OAuth. Použijte System.AccessToken ze skriptů YAML. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.CollectionId | Identifikátor GUID kolekce TFS nebo organizace Azure DevOps. | Ano |
System.CollectionUri | Identifikátor URI kolekce TFS nebo organizace Azure DevOps. Například: https://dev.azure.com/fabrikamfiber/ . |
Ano |
System.DefaultWorkingDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Příklad: c:\agent_work\1\s Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.DefinitionId | ID kanálu buildu. | Ano |
System.HostType | Nastavte, build jestli je kanál buildem. Pro vydání jsou deployment hodnoty pro úlohu skupiny nasazení, gates během vyhodnocení bran a release pro další úlohy (agent a bez agentů). |
Ano |
System.JobAttempt | Při prvním pokusu o tuto úlohu nastavíte na 1 a při každém opakování úlohy se zvýší. | No |
System.JobDisplayName | Jméno člověka čitelného pro práci. | No |
System.JobId | Jedinečný identifikátor jednoho pokusu o jednu úlohu. Hodnota je jedinečná pro aktuální kanál. | No |
System.JobName | Název úlohy, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.PhaseAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování úlohy se zvýší. Poznámka: Fáze je převážně redundantní koncept, který představuje dobu návrhu úlohy (zatímco úloha byla verzí modulu runtime fáze). Z Azure Pipelines jsme většinou odebrali koncept fáze. Matice a úlohy s více konfiguracemi jsou jediným místem, kde se "fáze" stále liší od úlohy. Jedna fáze může vytvořit instanci více úloh, které se liší pouze v jejich vstupech. |
No |
System.PhaseDisplayName | Lidsky čitelný název zadaný fázi. | No |
System.PhaseName | Identifikátor založený na řetězci pro úlohu, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.PlanId | Identifikátor založený na řetězci pro jedno spuštění kanálu. | No |
System.PullRequest.IsFork | Pokud žádost o přijetí změn pochází z forku úložiště, je tato proměnná nastavená na True hodnotu . V opačném případě je nastavená na False hodnotu . |
Ano |
System.PullRequest.PullRequestId | ID žádosti o přijetí změn, která způsobila toto sestavení. Například: 17 . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) |
No |
System.PullRequest.PullRequestNumber | Počet žádostí o přijetí změn, které způsobily toto sestavení Tato proměnná se vyplní pro žádosti o přijetí změn z GitHubu, které mají jiné ID žádosti o přijetí změn a číslo žádosti o přijetí změn. Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. | No |
System.PullRequest.targetBranchName | Název cílové větve žádosti o přijetí změn Tuto proměnnou lze použít v kanálu k podmíněnému spouštění úloh nebo kroků na základě cílové větve žádosti o přijetí změn. Můžete například chtít aktivovat jinou sadu testů nebo nástrojů pro analýzu kódu v závislosti na větvi, do které se změny slučují. | No |
System.PullRequest.SourceBranch | Větev, která se kontroluje v žádosti o přijetí změn Příklad: refs/heads/users/raisa/new-feature pro Azure Repos. (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. |
No |
System.PullRequest.SourceRepositoryURI | Adresa URL úložiště, které obsahuje žádost o přijetí změn. Například: https://dev.azure.com/ouraccount/_git/OurProject . |
No |
System.PullRequest.TargetBranch | Větev, která je cílem žádosti o přijetí změn. Příklad: refs/heads/main Když je úložiště v Azure Repos a main kdy je vaše úložiště na GitHubu. Tato proměnná se inicializuje jenom v případě, že se sestavení spustilo kvůli zásadám větve ovlivněné žádostmi o přijetí změn Gitu. Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. |
No |
System.StageAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování fáze se zvýší. | No |
System.StageDisplayName | Název, který je čitelný pro člověka, který je dán do fáze. | No |
System.StageName | Identifikátor založený na řetězci pro fázi, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.TeamFoundationCollectionUri | Identifikátor URI kolekce TFS nebo organizace Azure DevOps. Například: https://dev.azure.com/fabrikamfiber/ . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.TeamProject | Název projektu, který obsahuje toto sestavení. | Ano |
System.TeamProjectId | ID projektu, do kterého tento build patří. | Ano |
System.TimelineId | Identifikátor založený na řetězci pro podrobnosti spuštění a protokoly jednoho spuštění kanálu. | No |
TF_BUILD | Nastavte, True jestli skript spouští úloha sestavení. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Kontroluje proměnné (DevOps Server 2022)
Proměnná | Popis |
---|---|
Checks.StageAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování fáze se zvýší. Tuto proměnnou lze použít pouze ve schválení nebo kontrolovat prostředí. Můžete například použít $(Checks.StageAttempt) v rámci kontroly rozhraní REST API vyvolání. |
Proměnné agenta (DevOps Server 2020)
Poznámka:
Proměnné agenta můžete použít jako proměnné prostředí ve skriptech a jako parametry v úlohách sestavení. Nemůžete je použít k přizpůsobení čísla buildu nebo k použití popisku nebo značky správy verzí.
Proměnná | Popis |
---|---|
Agent.BuildDirectory | Místní cesta k agentu, kde se vytvoří všechny složky pro daný kanál buildu. Tato proměnná má stejnou hodnotu jako Pipeline.Workspace . Například: /home/vsts/work/1 . |
Agent.HomeDirectory | Adresář, do který je agent nainstalovaný. Obsahuje software agenta. Například: c:\agent . |
Agent.Id | ID agenta. |
Agent.JobName | Název spuštěné úlohy. Obvykle se jedná o úlohu nebo __default, ale ve scénářích s více konfiguracemi bude konfigurace. |
Agent.JobStatus | Stav sestavení.
AGENT_JOBSTATUS . agent.jobstatus Starší verze je k dispozici pro zpětnou kompatibilitu. |
Agent.MachineName | Název počítače, na kterém je agent nainstalovaný. |
Agent.Name | Název agenta zaregistrovaného ve fondu. Pokud používáte agenta v místním prostředí, nastaví se vám tento název. Podívejte se na agenty. |
Agent.OS | Operační systém hostitele agenta. Platné hodnoty jsou:
|
Agent.OSArchitecture | Architektura procesoru operačního systému hostitele agenta. Platné hodnoty jsou:
|
Agent.TempDirectory | Dočasná složka, která se vyčistí po každé úloze kanálu. Tento adresář používají úlohy, jako je úloha rozhraní příkazového řádku .NET Core, k uložení dočasných položek, jako jsou výsledky testů před jejich publikováním. Příklad: /home/vsts/work/_temp pro Ubuntu. |
Agent.ToolsDirectory | Adresář používaný úlohami, jako je instalační program nástroje Node Tool, a použít verzi Pythonu k přepínání mezi několika verzemi nástroje. Tyto úlohy přidávají nástroje z tohoto adresáře, PATH aby je mohly použít následné kroky sestavení. Přečtěte si o správě tohoto adresáře v místním agentu. |
Agent.WorkFolder | Pracovní adresář pro tohoto agenta. Například: c:\agent_work . Poznámka: U tohoto adresáře není zaručeno, že je možné zapisovat úkoly kanálu (například při mapování do kontejneru). |
Proměnné sestavení (DevOps Server 2020)
Pokud použijete proměnnou v šabloně, která není v šablonách označená jako dostupná, proměnná se nevykreslí. Proměnná se nevykreslí, protože její hodnota není přístupná v rámci oboru šablony.
Proměnná | Popis | K dispozici v šablonách? |
---|---|---|
Build.ArtifactStagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a . Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BuildId | ID záznamu pro dokončené sestavení. | No |
Build.BuildNumber | Název dokončeného sestavení, označovaný také jako číslo spuštění. Můžete zadat , co je součástí této hodnoty. Typickým použitím této proměnné je, aby byla součástí formátu popisku, který zadáte na kartě úložiště. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BuildUri | Identifikátor URI sestavení. Například: vstfs:///Build/Build/1430 . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.BinariesDirectory | Místní cesta k agentu, kterou můžete použít jako výstupní složku pro kompilované binární soubory. Ve výchozím nastavení nejsou nové kanály buildu nastavené pro vyčištění tohoto adresáře. Sestavení můžete definovat a vyčistit ho na kartě Úložiště. Například: c:\agent_work\1\b . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.ContainerId | ID kontejneru pro váš artefakt. Když do kanálu nahrajete artefakt, přidá se do kontejneru, který je specifický pro daný artefakt. | No |
Build.DefinitionName | Název kanálu buildu. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.DefinitionVersion | Verze kanálu buildu. | Ano |
Build.QueuedBy | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.QueuedById | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.Reason | Událost, která způsobila spuštění sestavení.
|
Ano |
Build.Repository.Clean | Hodnota, kterou jste vybrali pro vyčištění v nastavení zdrojového úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.LocalPath | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s . Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Důležitá poznámka: Pokud si projdete jenom jedno úložiště Git, bude tato cesta přesnou cestou k kódu. Pokud si prohlédnete více úložišť, chování je následující (a může se lišit od hodnoty proměnné Build.SourcesDirectory):
|
No |
Build.Repository.ID | Jedinečný identifikátor úložiště. To se nezmění, i když se název úložiště změní. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Name | Název aktivačního úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Provider | Typ aktivovaného úložiště.
|
No |
Build.Repository.Tfvc.Workspace | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Název pracovního prostoru TFVC, který používá agent sestavení. Pokud je c:\agent_work\12 například Agent.BuildDirectory a Agent.Id je 8 , název pracovního prostoru může být: ws_12_8 . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Uri | Adresa URL pro aktivované úložiště. Příklad: Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.RequestedFor | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Ano |
Build.RequestedForEmail | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.RequestedForId | Přečtěte si téma "Jak jsou nastavené proměnné identity?". | Ano |
Build.SourceBranch | Větev aktivačního úložiště, pro které bylo sestavení zařazeno do fronty. Některé příklady:
/ ) se nahradí podtržítkem _ ). Poznámka: Pokud v TFVC spouštíte vrátný build check-in nebo ručně vytváříte sadu odložených položek, nemůžete tuto proměnnou použít ve formátu čísla buildu. |
Ano |
Build.SourceBranchName | Název větve v aktivačním úložišti, pro které bylo sestavení zařazeno do fronty.
|
Ano |
Build.SourcesDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s . Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Důležitá poznámka: Pokud si prohlédnete jenom jedno úložiště Git, je tato cesta přesnou cestou ke kódu. Pokud si prohlédnete více úložišť, vrátí se k výchozí hodnotě, což je $(Pipeline.Workspace)/s , i když je vlastní (primární) úložiště rezervováno na vlastní cestu, která se liší od výchozí cesty $(Pipeline.Workspace)/s/<RepoName> s více rezervacemi (v tomto ohledu se proměnná liší od chování proměnné Build.Repository.LocalPath). Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.SourceVersion | Nejnovější změna správy verzí aktivačního úložiště, které je součástí tohoto buildu.
|
Ano |
Build.SourceVersionMessage | Komentář k potvrzení nebo sadě změn pro aktivační úložiště. Zprávu zkrátíme na první řádek nebo 200 znaků podle toho, co je kratší. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Tato proměnná je k dispozici pouze na úrovni kroku a není k dispozici v úrovních úlohy nebo fáze (to znamená, že zpráva se nevyextrahuje, dokud úloha nezačala a nezaškrtla kód). Poznámka: Tato proměnná je k dispozici v TFS 2015.4. Poznámka: Proměnná Build.SourceVersionMessage nefunguje s klasickými kanály buildu v úložištích Bitbucket, když je povolená služba Batch, zatímco probíhá sestavení. |
No |
Build.StagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a . Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.Repository.Git.SubmoduleCheckout | Hodnota, kterou jste vybrali pro dílčí režimy rezervace na kartě úložiště. U rezervovaných více úložišť tato hodnota sleduje nastavení aktivujícího úložiště. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.SourceTfvcShelveset | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Pokud používáte vrátný build nebo build sady odložených odložených razítek, nastaví se na název sady odlic, kterou vytváříte. Poznámka: Tato proměnná poskytuje hodnotu, která je neplatná pro použití sestavení ve formátu čísla sestavení. |
No |
Build.TriggeredBy.BuildId | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na BuildID aktivačního sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.TriggeredBy.DefinitionId | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na DefinitionID aktivačního sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.TriggeredBy.DefinitionName | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na název aktivačního kanálu sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.TriggeredBy.BuildNumber | Pokud se sestavení aktivovalo jiným sestavením, nastaví se tato proměnná na počet aktivačních sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Build.TriggeredBy.ProjectID | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na ID projektu, který obsahuje aktivační sestavení. Vklasických Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Common.TestResultsDirectory | Místní cesta k agentu, kde se vytvoří výsledky testu. Například: c:\agent_work\1\TestResults . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Proměnné kanálu (DevOps Server 2020)
Proměnná | Popis |
---|---|
Pipeline.Workspace | Adresář pracovního prostoru pro konkrétní kanál Tato proměnná má stejnou hodnotu jako Agent.BuildDirectory . Například /home/vsts/work/1 . |
Proměnné úlohy nasazení (DevOps Server 2020)
Tyto proměnné jsou vymezeny na konkrétní úlohu nasazení a budou vyřešeny pouze v době provádění úlohy.
Proměnná | Popis |
---|---|
Environment.Name | Název prostředí cíleného na úlohu nasazení pro spuštění kroků nasazení a zaznamenání historie nasazení. Například smarthotel-dev . |
Environment.Id | ID prostředí určeného v úloze nasazení. Například 10 . |
Environment.ResourceName | Název konkrétního prostředku v prostředí určeném v úloze nasazení pro spuštění kroků nasazení a zaznamenání historie nasazení. Jedná se například bookings o obor názvů Kubernetes, který byl přidán jako prostředek do prostředí smarthotel-dev . |
Environment.ResourceId | ID konkrétního prostředku v rámci prostředí určeného v úloze nasazení pro spuštění kroků nasazení. Například 4 . |
Systémové proměnné (DevOps Server 2020)
Pokud použijete proměnnou v šabloně, která není v šablonách označená jako dostupná, proměnná se nevykreslí. Proměnná se nevykreslí, protože její hodnota není přístupná v rámci oboru šablony.
Proměnná | Popis | K dispozici v šablonách? |
---|---|---|
System.AccessToken | Pro přístup k rozhraní REST API použijte token OAuth. Použijte System.AccessToken ze skriptů YAML. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.CollectionId | Identifikátor GUID kolekce TFS nebo organizace Azure DevOps | Ano |
System.CollectionUri | Řetězcový identifikátor URI kolekce Team Foundation Serveru. | Ano |
System.DefaultWorkingDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Příklad: c:\agent_work\1\s Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
System.DefinitionId | ID kanálu buildu. | Ano |
System.HostType | Nastavte, build jestli je kanál buildem. Pro vydání jsou deployment hodnoty pro úlohu skupiny nasazení, gates během vyhodnocení bran a release pro další úlohy (agent a bez agentů). |
Ano |
System.JobAttempt | Při prvním pokusu o tuto úlohu nastavíte na 1 a při každém opakování úlohy se zvýší. | No |
System.JobDisplayName | Jméno člověka čitelného pro práci. | No |
System.JobId | Jedinečný identifikátor jednoho pokusu o jednu úlohu. Hodnota je jedinečná pro aktuální kanál. | No |
System.JobName | Název úlohy, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.PhaseAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování úlohy se zvýší. Poznámka: Fáze je převážně redundantní koncept, který představuje dobu návrhu úlohy (zatímco úloha byla verzí modulu runtime fáze). Z Azure Pipelines jsme většinou odebrali koncept fáze. Matice a úlohy s více konfiguracemi jsou jediným místem, kde se "fáze" stále liší od úlohy. Jedna fáze může vytvořit instanci více úloh, které se liší pouze v jejich vstupech. |
No |
System.PhaseDisplayName | Lidsky čitelný název zadaný fázi. | No |
System.PhaseName | Identifikátor založený na řetězci pro úlohu, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | No |
System.StageAttempt | Při prvním pokusu o tuto fázi se nastaví hodnota 1 a při každém opakování úlohy se zvýší. | No |
System.StageDisplayName | Název, který je čitelný pro člověka, který je dán do fáze. | No |
System.StageName | Identifikátor založený na řetězci pro fázi, obvykle používaný pro vyjádření závislostí a přístup k výstupním proměnným. | Ano |
System.PullRequest.IsFork | Pokud žádost o přijetí změn pochází z forku úložiště, je tato proměnná nastavená na True hodnotu . V opačném případě je nastavená na False hodnotu . |
Ano |
System.PullRequest.PullRequestId | ID žádosti o přijetí změn, která způsobila toto sestavení. Například: 17 . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) |
No |
System.PullRequest.PullRequestNumber | Počet žádostí o přijetí změn, které způsobily toto sestavení Tato proměnná se vyplní pro žádosti o přijetí změn z GitHubu, které mají jiné ID žádosti o přijetí změn a číslo žádosti o přijetí změn. Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. | No |
System.PullRequest.targetBranchName | Název cílové větve žádosti o přijetí změn Tuto proměnnou lze použít v kanálu k podmíněnému spouštění úloh nebo kroků na základě cílové větve žádosti o přijetí změn. Můžete například chtít aktivovat jinou sadu testů nebo nástrojů pro analýzu kódu v závislosti na větvi, do které se změny slučují. | No |
System.PullRequest.SourceBranch | Větev, která se kontroluje v žádosti o přijetí změn Například: refs/heads/users/raisa/new-feature . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. |
No |
System.PullRequest.SourceCommitId | Potvrzení, které se kontroluje v žádosti o přijetí změn. (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve) Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. | |
System.PullRequest.SourceRepositoryURI | Adresa URL úložiště, které obsahuje žádost o přijetí změn. Například: https://dev.azure.com/ouraccount/_git/OurProject . |
No |
System.PullRequest.TargetBranch | Větev, která je cílem žádosti o přijetí změn. Příklad: refs/heads/main Když je úložiště v Azure Repos a main kdy je vaše úložiště na GitHubu. Tato proměnná se inicializuje jenom v případě, že se sestavení spustilo kvůli zásadám větve ovlivněné žádostmi o přijetí změn Gitu. Tato proměnná je k dispozici pouze v kanálu YAML, pokud je žádost o přijetí změn ovlivněná zásadami větve. |
No |
System.TeamFoundationCollectionUri | Identifikátor URI kolekce základu týmu. Například: https://dev.azure.com/fabrikamfiber/ . Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Ano |
System.TeamProject | Název projektu, který obsahuje toto sestavení. | Ano |
System.TeamProjectId | ID projektu, do kterého tento build patří. | Ano |
TF_BUILD | Nastavte, True jestli skript spouští úloha sestavení. Tato proměnná je vymezená agentem a dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
No |
Proměnné agenta (DevOps Server 2019)
Poznámka:
Proměnné agenta můžete použít jako proměnné prostředí ve skriptech a jako parametry v úlohách sestavení. Nemůžete je použít k přizpůsobení čísla buildu nebo k použití popisku nebo značky správy verzí.
Proměnná | Popis |
---|---|
Agent.BuildDirectory | Místní cesta k agentu, kde se vytvoří všechny složky pro daný kanál buildu. Například: c:\agent_work\1 . |
Agent.HomeDirectory | Adresář, do který je agent nainstalovaný. Obsahuje software agenta. Například: c:\agent . |
Agent.Id | ID agenta. |
Agent.JobName | Název spuštěné úlohy. Obvykle se jedná o úlohu nebo __default, ale ve scénářích s více konfiguracemi bude konfigurace. |
Agent.JobStatus | Stav sestavení.
AGENT_JOBSTATUS . agent.jobstatus Starší verze je k dispozici pro zpětnou kompatibilitu. |
Agent.MachineName | Název počítače, na kterém je agent nainstalovaný. |
Agent.Name | Název agenta zaregistrovaného ve fondu. Pokud používáte agenta v místním prostředí, nastaví se tento název. Podívejte se na agenty. |
Agent.OS | Operační systém hostitele agenta. Platné hodnoty jsou:
|
Agent.OSArchitecture | Architektura procesoru operačního systému hostitele agenta. Platné hodnoty jsou:
|
Agent.TempDirectory | Dočasná složka, která se vyčistí po každé úloze kanálu. Tento adresář používají úlohy, jako je úloha rozhraní příkazového řádku .NET Core, k uložení dočasných položek, jako jsou výsledky testů před jejich publikováním. |
Agent.ToolsDirectory | Adresář používaný úlohami, jako je instalační program nástroje Node Tool, a použít verzi Pythonu k přepínání mezi několika verzemi nástroje. Tyto úlohy přidávají nástroje z tohoto adresáře, PATH aby je mohly použít následné kroky sestavení. Přečtěte si o správě tohoto adresáře v místním agentu. |
Agent.WorkFolder | Pracovní adresář pro tohoto agenta. Například: c:\agent_work . U tohoto adresáře není zaručeno, že je možné zapisovat úkoly kanálu (například při mapování do kontejneru). |
Sestavení proměnných (DevOps Server 2019)
Proměnná | Popis |
---|---|
Build.ArtifactStagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a . Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.BuildId | ID záznamu pro dokončené sestavení. |
Build.BuildNumber | Název dokončeného sestavení. V možnostech kanálu můžete zadat formát čísla buildu, který vygeneruje tuto hodnotu. Typickým použitím této proměnné je, aby byla součástí formátu popisku, který zadáte na kartě úložiště. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.BuildUri | Identifikátor URI sestavení. Například: vstfs:///Build/Build/1430 . Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.BinariesDirectory | Místní cesta k agentu, kterou můžete použít jako výstupní složku pro kompilované binární soubory. Ve výchozím nastavení nejsou nové kanály buildu nastavené pro vyčištění tohoto adresáře. Sestavení můžete definovat a vyčistit ho na kartě Úložiště. Například: c:\agent_work\1\b . Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.DefinitionName | Název kanálu buildu. Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Build.DefinitionVersion | Verze kanálu buildu. |
Build.QueuedBy | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Build.QueuedById | Přečtěte si téma "Jak jsou nastavené proměnné identity?". |
Build.Reason | Událost, která způsobila spuštění sestavení.
|
Build.Repository.Clean | Hodnota, kterou jste vybrali pro vyčištění v nastavení zdrojového úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.Repository.LocalPath | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Příklad: c:\agent_work\1\s Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Tato proměnná je synonymem build.SourcesDirectory. |
Build.Repository.Name | Název úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.Repository.Provider | Typ úložiště, které jste vybrali.
|
Build.Repository.Tfvc.Workspace | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Název pracovního prostoru TFVC, který používá agent sestavení. Pokud je c:\agent_work\12 například Agent.BuildDirectory a Agent.Id je 8 , název pracovního prostoru může být: ws_12_8 . Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.Repository.Uri | Adresa URL úložiště. Příklad: Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.RequestedFor | Přečtěte si téma "Jak jsou nastavené proměnné identity?". Poznámka: Tato hodnota může obsahovat prázdné znaky nebo jiné neplatné znaky popisku. V těchto případech se formát popisku nezdaří. |
Build.RequestedForEmail | Přečtěte si téma "Jak jsou nastavené proměnné identity?". |
Build.RequestedForId | Přečtěte si téma "Jak jsou nastavené proměnné identity?". |
Build.SourceBranch | Větev, pro které bylo sestavení zařazeno do fronty. Některé příklady:
/ ) se nahradí podtržítkem (_ ). Poznámka: Pokud v TFVC spouštíte vrátný build check-in nebo ručně vytváříte sadu odložených položek, nemůžete tuto proměnnou použít ve formátu čísla buildu. |
Build.SourceBranchName | Název větve, pro které byl build zařazen do fronty.
|
Build.SourcesDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Například: c:\agent_work\1\s .Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Tato proměnná je synonymem build.Repository.LocalPath. |
Build.SourceVersion | Nejnovější změna správy verzí, která je součástí tohoto buildu.
|
Build.SourceVersionMessage | Komentář k potvrzení nebo sadě změn. Zprávu zkrátíme na první řádek nebo 200 znaků podle toho, co je kratší. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. Poznámka: Tato proměnná je k dispozici v TFS 2015.4. Poznámka: Proměnná Build.SourceVersionMessage nefunguje s klasickými kanály buildu v úložištích Bitbucket, když je povolená služba Batch, zatímco probíhá sestavení. |
Build.StagingDirectory | Místní cesta k agentu, do kterého se před vložením do cíle zkopírují všechny artefakty. Například: c:\agent_work\1\a . Typickým způsobem použití této složky je publikování artefaktů sestavení pomocí úloh Kopírování souborů a publikování artefaktů sestavení. Poznámka: Build.ArtifactStagingDirectory a Build.StagingDirectory jsou zaměnitelné. Tento adresář se vymaže před každým novým sestavením, takže si ho nemusíte vyčistit sami. Viz Artefakty ve službě Azure Pipelines. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.Repository.Git.SubmoduleCheckout | Hodnota, kterou jste vybrali pro dílčí režimy rezervace na kartě úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.SourceTfvcShelveset | Definuje se, jestli je vaše úložiště Správa verzí Team Foundation. Pokud používáte vrátný build nebo build sady odložených odložených razítek, nastaví se na název sady odlic, kterou vytváříte. Poznámka: Tato proměnná poskytuje hodnotu, která je neplatná pro použití sestavení ve formátu čísla sestavení. |
Build.TriggeredBy.BuildId | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na BuildID aktivačního sestavení. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.TriggeredBy.DefinitionId | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na DefinitionID aktivačního sestavení. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.TriggeredBy.DefinitionName | Pokud se sestavení aktivovalo jiným sestavením, je tato proměnná nastavená na název aktivačního kanálu sestavení. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.TriggeredBy.BuildNumber | Pokud se sestavení aktivovalo jiným sestavením, nastaví se tato proměnná na počet aktivačních sestavení. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Build.TriggeredBy.ProjectID | Pokud sestavení aktivoval jiný build, je tato proměnná nastavená na ID projektu, který obsahuje aktivační sestavení. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Common.TestResultsDirectory | Místní cesta k agentu, kde se vytvoří výsledky testu. Například: c:\agent_work\1\TestResults . Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Systémové proměnné (DevOps Server 2019)
Ukázkový skript PowerShellu: Přístup k rozhraní REST API
Proměnná | Popis |
---|---|
System.AccessToken | Pro přístup k rozhraní REST API použijte token OAuth. Použijte System.AccessToken ze skriptů YAML. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
System.CollectionId | Identifikátor GUID kolekce TFS nebo organizace Azure DevOps |
System.DefaultWorkingDirectory | Místní cesta k agentu, do kterého se stáhnou vaše soubory zdrojového kódu. Příklad: c:\agent_work\1\s Ve výchozím nastavení se nové kanály buildu aktualizují jenom změněné soubory. Způsob stahování souborů můžete změnit na kartě Úložiště. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
System.DefinitionId | ID kanálu buildu. |
System.HostType | Nastavte, build jestli je kanál buildem. Pro verzi jsou deployment hodnoty pro úlohu skupiny nasazení a release pro úlohu agenta. |
System.PullRequest.IsFork | Pokud žádost o přijetí změn pochází z forku úložiště, je tato proměnná nastavená na True hodnotu . V opačném případě je nastavena na False hodnotu . |
System.PullRequest.PullRequestId | ID žádosti o přijetí změn, která způsobila toto sestavení. Například: 17 . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve.) |
System.PullRequest.PullRequestNumber | Počet žádostí o přijetí změn, které způsobily toto sestavení Tato proměnná se vyplní pro žádosti o přijetí změn z GitHubu, které mají jiné ID žádosti o přijetí změn a číslo žádosti o přijetí změn. |
System.PullRequest.SourceBranch | Větev, která se kontroluje v žádosti o přijetí změn Například: refs/heads/users/raisa/new-feature . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve.) |
System.PullRequest.SourceCommitId | Potvrzení, které se kontroluje v žádosti o přijetí změn. (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Žádost o přijetí změn Gitu ovlivněná zásadami větve.) |
System.PullRequest.SourceRepositoryURI | Adresa URL úložiště, které obsahuje žádost o přijetí změn. Například: https://dev.azure.com/ouraccount/_git/OurProject . (Tato proměnná se inicializuje pouze v případě, že se sestavení spustilo z důvodu Zásady pro větev mají vliv na žádosti o přijetí změn gitu v Azure Repos. Není inicializován pro žádosti o přijetí změn v GitHubu.) |
System.PullRequest.TargetBranch | Větev, která je cílem žádosti o přijetí změn. Například: refs/heads/main . Tato proměnná se inicializuje jenom v případě, že se sestavení spustilo kvůli zásadám větve ovlivněné žádostmi o přijetí změn Gitu. |
System.TeamFoundationCollectionUri | Identifikátor URI kolekce základu týmu. Například: https://dev.azure.com/fabrikamfiber/ . Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
System.TeamProject | Název projektu, který obsahuje toto sestavení. |
System.TeamProjectId | ID projektu, do kterého tento build patří. |
TF_BUILD | Nastavte, True jestli skript spouští úloha sestavení. Tato proměnná má obor agenta. Dá se použít jako proměnná prostředí ve skriptu a jako parametr v úloze sestavení, ale ne jako součást čísla sestavení nebo jako značka správy verzí. |
Jak jsou nastavené proměnné identity?
Hodnota závisí na tom, co způsobilo sestavení a které jsou specifické pro úložiště Azure Repos.
Pokud se sestavení aktivuje... | Hodnoty Build.QueuedBy a Build.QueuedById jsou pak založeny na... | Pak jsou hodnoty Build.RequestedFor a Build.RequestedForId založeny na... |
---|---|---|
V Gitu nebo triggery kontinuální integrace (CI) | Systémová identita, například: [DefaultCollection]\Project Collection Service Accounts |
Osoba, která změny odeslala nebo zkontrolovala. |
V Gitu nebo sestavením zásad větve | Systémová identita, například: [DefaultCollection]\Project Collection Service Accounts |
Osoba, která změny zkontrolovala. |
V TFVC bránou triggerem vrácení se změnami | Osoba, která změny zkontrolovala. | Osoba, která změny zkontrolovala. |
V Gitu nebo TFVC podle plánovaných triggerů | Systémová identita, například: [DefaultCollection]\Project Collection Service Accounts |
Systémová identita, například: [DefaultCollection]\Project Collection Service Accounts |
Protože jste klikli na tlačítko Sestavení fronty | Vy | Vy |