定義済み変数の使用

Azure Pipelines | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2015

注意

Microsoft Team Foundation Server (TFS) 2018 以前のバージョンでは、ビルドとリリースの "パイプライン" は "定義"、"実行" は "ビルド"、"サービス接続" は "サービス エンドポイント"、"ステージ" は "環境"、"ジョブ" は "フェーズ" と呼ばれます。

変数を使用すると、パイプラインのさまざまな部分に重要なデータを簡単に取り込むことができます。 これは、使用可能な定義済み変数の一覧です。 他にもいくつかの定義済みの変数がありますが、ほとんどは内部で使用するためのものです。

これらの変数は、システムによって自動的に設定され、読み取り専用になります。 (例外は Build. Clean および system.string です)。

YAML パイプラインでは、定義済みの変数を環境変数として参照できます。 たとえば、変数は Build.ArtifactStagingDirectory 変数になり BUILD_ARTIFACTSTAGINGDIRECTORY ます。

クラシックパイプラインでは、デプロイタスクで リリース変数 を使用して、共通情報 (環境名、リソースグループなど) を共有できます。

詳細については 、変数の使用に関するページを参照してください。

ビルド。クリーン

これは非推奨の変数であり、ビルドエージェントによるソースのクリーンアップ方法を変更します。 ソースをクリーンアップする方法については、「 エージェントでのローカルリポジトリのクリーンアップ」を参照してください。

この変数は、ビルドエージェントによるソースのクリーンアップ方法を変更します。 詳細については、「 エージェントでのローカルリポジトリのクリーンアップ」を参照してください。

AccessToken

System.AccessToken は、実行中のビルドで使用されるセキュリティトークンを格納する特殊な変数です。

YAML では、 System.AccessToken 変数を使用してパイプラインに明示的にマップする必要があります。 これは、ステップまたはタスクレベルで実行できます。

steps:
  - bash: echo This script could use $SYSTEM_ACCESSTOKEN
    env:
      SYSTEM_ACCESSTOKEN: $(System.AccessToken)
  - powershell: Write-Host "This is a script that could use $env:SYSTEM_ACCESSTOKEN"
    env:
      SYSTEM_ACCESSTOKEN: $(System.AccessToken)

System.AccessTokenビルドジョブの承認スコープを使用するための既定のスコープを構成できます。

System.string

パイプラインの問題をデバッグするための詳細なログについては、 System.Debug を定義してに設定し true ます。

  1. パイプラインを編集します。

  2. [変数] を選択します。

  3. という名前の新しい変数を追加し System.Debug true ます。

    システムデバッグを true に設定

  4. 新しい変数を保存します。

エージェントの変数 (DevOps Services)

注意

エージェント変数は、スクリプト内で環境変数として使用することも、ビルドタスクのパラメーターとして使用することもできます。 これらの値を使用して、ビルド番号をカスタマイズしたり、バージョンコントロールのラベルまたはタグを適用したりすることはできません。

変数説明
エージェントの BuildDirectory

指定されたビルドパイプラインのすべてのフォルダーが作成されるエージェントのローカルパス。 この変数の値はと同じ Pipeline.Workspace です。

例: /home/vsts/work/1

ContainerMapping

実行時の YAML のコンテナーリソース名から Docker Id へのマッピング。

次に例を示します。

{
  "one_container": {
    "id": "bdbb357d73a0bd3550a1a5b778b62a4c88ed2051c7802a0659f1ff6e76910190"
  },
  "another_container": {
    "id": "82652975109ec494876a8ccbb875459c945982952e0a72ad74c91216707162bb"
  }
}

HomeDirectory エージェントがインストールされているディレクトリ。 これには、エージェントソフトウェアが含まれます。 (例: c:\agent)。
Agent.Id エージェントの ID。
JobName 実行中のジョブの名前。 これは通常 " 、Job " または " __default " ですが、複数構成のシナリオでは、が構成になります。
JobStatus ビルドの状態。
  • Canceled
  • Failed
  • Succeeded
  • SucceededWithIssues (部分的に成功)

環境変数はとして参照する必要があり AGENT_JOBSTATUS ます。 旧バージョンとの agent.jobstatus 互換性を維持するために使用できます。

エージェント. MachineName エージェントがインストールされているコンピューターの名前。
Agent.Name

プールに登録されているエージェントの名前。

自己ホスト型エージェントを使用している場合は、この名前が指定されます。 「 エージェント」を参照してください。

エージェント. OS エージェントホストのオペレーティングシステム。 有効な値は次のとおりです。
  • Windows_NT
  • Darwin
  • Linux
コンテナーで実行し'場合、エージェントのホストとコンテナーは異なるオペレーティングシステムを実行している可能性があります。
エージェント. OSArchitecture エージェントホストのオペレーティングシステムプロセッサアーキテクチャ。 有効な値は次のとおりです。
  • X86
  • X64
  • ARM
Agent. TempDirectory

各パイプラインジョブの後に消去される一時フォルダー。 このディレクトリは、発行前にテスト結果などの一時項目を保持するために、 .NET Core CLI タスク などのタスクによって使用されます。

例: /home/vsts/work/_temp Ubuntu の場合

エージェント.? ディレクトリ ノードツールインストーラーなどのタスクによって使用されるディレクトリ。 Python バージョンを使用して、複数のバージョンのツールを切り替えます。 これらのタスクは、このディレクトリからにツールを追加し PATH て、後続のビルドステップでそれらを使用できるようにします。

自己ホスト型エージェントでのこのディレクトリの管理について説明します。
エージェント. ワークフォルダー このエージェントの作業ディレクトリ。 (例: c:\agent_work)。

注: このディレクトリは、パイプラインタスクによって書き込み可能であるとは限りません (例: コンテナーにマップされている場合)

ビルド変数 (DevOps Services)


変数説明テンプレートで使用できますか?
Build.artifactstagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

いいえ
BuildId 完了したビルドのレコードの ID。 いいえ
Build.BuildNumber 完了したビルドの名前。実行番号とも呼ばれます。 この値に 含まれる内容 を指定できます。

この変数の一般的な用途は、[ リポジトリ] タブで指定するラベル形式の一部にすることです。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。



この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

いいえ
BuildUri ビルドの URI。 (例: vstfs:///Build/Build/1430)。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
BinariesDirectory コンパイルされたバイナリの出力フォルダーとして使用できるエージェントのローカルパス。

既定では、新しいビルドパイプラインは、このディレクトリを消去するように設定されていません。 [ リポジトリ] タブでビルドをクリーンアップするように定義できます。

(例: c:\agent_work\1\b)。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ビルド ContainerId アーティファクトのコンテナーの ID。 パイプライン内のアーティファクトをアップロードすると、その特定の成果物に固有のコンテナーに追加されます。 いいえ
Build.DefinitionName ビルドパイプラインの名前。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

はい
ビルド. DefinitionVersion ビルドパイプラインのバージョン。 はい
Build.QueuedBy 「ID " 変数の設定方法」を参照してください " 。

注: この値には、空白文字または他の無効なラベル文字を含めることができます。 このような場合、ラベル形式 失敗します。

はい
Build.QueuedById 「ID " 変数の設定方法」を参照してください " 。 はい
Build.Reason ビルドの実行を引き起こしたイベント。
  • Manual: ユーザーがビルドを手動でキューに登録しました。
  • IndividualCI: Git プッシュまたは TFVC チェックインによってトリガーされる継続的インテグレーション(CI)。
  • BatchedCI: Git プッシュまたは TFVC チェックインによってトリガーされる継続的インテグレーション (CI) と 、Batch の変更が選択されました。
  • Schedule: スケジュールされた トリガー。
  • ValidateShelveset: ユーザーは、特定の TFVC ブレットのビルドを手動でキューに登録しました。
  • CheckInShelveset: ゲート チェックイン トリガー
  • PullRequest:ビルドは、ビルドを必要とする Git ブランチ ポリシーによってトリガーされました。
  • ResourceTrigger: ビルドが リソース トリガーによってトリガーされたか、 別のビルド によってトリガーされました
パイプライン トリガーのビルド」、ブランチポリシーを使用したコード品質の向上に関するページを参照してください
はい
Build.Repository.Clean [クリーン] に'ソース リポジトリ の設定で 選択 した値

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。
いいえ
Build.Repository.LocalPath

ソース コード ファイルがダウンロードされるエージェントのローカル パス。 例: c:\agent_work\1\s

既定では、新しいビルド パイプラインは変更されたファイルのみを更新します。 [リポジトリ] タブで、ファイルのダウンロード方法 を変更できます。重要な注意: 1 つの Git リポジトリのみをチェックアウトする場合、このパスはコードへの正確なパスになります。 複数のリポジトリをチェックアウトすると、既定値 () に戻されます $(Pipeline.Workspace)/s

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。

この変数は Build.SourcesDirectory と同義です。

いいえ
Build.Repository.ID リポジトリ の一意識別子。

リポジトリの'場合でも、これは変更されません。

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。
いいえ
Build.Repository.Name トリガーするリポジトリの 名前

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。
いいえ
Build.Repository.Provider トリガーするリポジトリ の この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。 いいえ
Build.Repository.Tfvc.Workspace リポジトリが作成 されている場合 に定義Team Foundation バージョン管理。 ビルド エージェント によって使用される TFVC ワークスペースの名前。


たとえば、Agent.BuildDirectory が で、その Agent.Id の場合、 c:\agent_work\12 8 ワークスペース名は次のようになります。 ws_12_8

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。
いいえ
Build.Repository.Uri トリガーするリポジトリの URL。 次に例を示します。 この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。 いいえ
Build.RequestedFor 「ID " 変数の設定方法」を参照してください " 。

注: この値には、空白文字または他の無効なラベル文字を含めることができます。 このような場合、ラベル形式 失敗します。

はい
Build.RequestedForEmail 「ID " 変数の設定方法」を参照してください " 。 はい
Build.RequestedForId 「ID " 変数の設定方法」を参照してください " 。 はい
Build.SourceBranch ビルドがキューに入れらたトリガーするレポポの分岐。 次に例をいくつか示します。
  • Git リポジトリ ブランチ: refs/heads/master
  • Git リポジトリ pull request: refs/pull/1/merge
  • TFVC Repo branch: $/teamproject/main
  • TFVC Repo gated check-in: Gated_2016-06-06_05.20.51.4369;username@live.com
  • TFVC レポブセットビルド: myshelveset;username@live.com
  • パイプラインがタグによってトリガーされた場合: refs/tags/your-tag-name
この変数をビルド番号形式で使用すると、スラッシュ文字 ( ) がアンダー / スコア文字 に置き換えられます _

注: TFVC では、ゲート チェックイン ビルドを実行している場合、または手動でブブセットを作成している場合は、ビルド番号形式でこの変数を使用することはできません。
はい
Build.SourceBranchName ビルドがキューに入れらた、トリガーするレポポのブランチの名前。
  • Git リポジトリのブランチまたはpull request: ref 内の最後のパス セグメント。たとえば、この値 refs/heads/master は です master 。 この refs/heads/feature/tools 値は です tools
  • TFVC repo branch: ワークスペースのルート サーバー パスの最後のパス セグメント。 たとえば、この値 $/teamproject/main では 次のようになります。 main.
  • TFVC レポポのゲート チェックインまたはブレットセットのビルドは、ブレットセットの名前です。 たとえば、Gated_2016-06-06_05.20.51.4369;username@live.com または myshelveset;username@live.com です。
注: TFVC では、ゲート チェックイン ビルドを実行している場合、または手動でブブセットを作成している場合は、ビルド番号形式でこの変数を使用することはできません。
はい
Build.SourcesDirectory

ソース コード ファイルがダウンロードされるエージェントのローカル パス。 例: c:\agent_work\1\s

既定では、新しいビルド パイプラインは変更されたファイルのみを更新します。

重要な注意: Git リポジトリを1つだけチェックアウトする場合、このパスはコードの正確なパスになります。 複数のリポジトリをチェックアウトすると、そのリポジトリは既定値であるに戻り $(Pipeline.Workspace)/s ます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は LocalPath と同義です。

いいえ
ビルド SourceVersion このビルドに含まれるトリガーしているリポジトリの最新バージョンコントロールの変更。 この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。 はい
SourceVersionMessage をビルドします。 トリガーしているリポジトリのコミットまたは変更セットのコメント。 メッセージは、最初の行または200文字のいずれか短い方に切り捨てられます。

は、 Build.SourceVersionMessage コミット時のメッセージに対応し Build.SourceVersion ます。 Build.SourceVersionPR ビルドのコミットは、マージコミットです (ソースブランチのコミットではありません)。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。 また、この変数はステップレベルでのみ使用でき、ジョブでもステージレベルでも使用できません (つまり、ジョブが開始されてコードがチェックアウトされるまで、メッセージは抽出されません)。

注: この変数は、TFS 2015.4 で使用できます。

いいえ
Build.stagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

いいえ
ビルド. Git. SubmoduleCheckout [リポジトリ] タブで、チェックアウト用に選択した'の値 (サブモジュール)。複数のリポジトリがチェックアウトされている場合、この値はトリガーしているリポジトリの設定を追跡します。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
SourceTfvcShelveset をビルドします。 リポジトリが Team Foundation バージョン管理場合に定義されます。


ゲートビルドまたはシェルブセットビルドを実行している場合は、ビルドしているシェルブセットの名前に設定されます。

メモ: この変数は、ビルド番号形式でのビルドの使用に対して無効な値を生成します。
いいえ
BuildId を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数はトリガービルドの BuildID に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
DefinitionId を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数はトリガービルドの DefinitionID に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ビルド. DefinitionName ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガーを起動するビルドパイプラインの名前に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ビルドします。 ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガーするビルドの番号に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ProjectID を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガービルドを含むプロジェクトの ID に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
一般的な Testのディレクトリ テスト結果が作成されるエージェントのローカルパス。 たとえば、c:\agent_work\1\TestResults のようにします。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ

パイプラインの変数 (DevOps Services)

変数説明
Pipeline. ワークスペース 特定のパイプラインのワークスペースディレクトリ。 この変数の値はと同じ Agent.BuildDirectory です。

たとえば、「 /home/vsts/work/1 」のように入力します。

配置ジョブ変数 (DevOps Services)

これらの変数は特定の 配置ジョブ にスコープが設定され、ジョブの実行時にのみ解決されます。

変数説明
Environment.Name 配置手順を実行して配置履歴を記録する配置ジョブを対象とする環境の名前。 たとえば、「 smarthotel-dev 」のように入力します。
Environment.Id 配置ジョブを対象とする環境の ID。 たとえば、「 10 」のように入力します。
環境.......... 配置の手順を実行してデプロイの履歴を記録するために、配置ジョブの対象となる環境内の特定のリソースの名前。 たとえば、 bookings 環境にリソースとして追加された Kubernetes 名前空間です smarthotel-dev
環境. ResourceId 配置手順を実行する配置ジョブを対象とする環境内の特定のリソースの ID。 たとえば、「 4 」のように入力します。
Strategy.Name 配置戦略の名前 canary (、 runOnce 、または rolling )。
CycleName デプロイ内の現在のサイクル名。 オプションは PreIteration 、、 Iteration 、または PostIteration です。

システム変数 (DevOps Services)

変数説明テンプレートで使用できますか?
AccessToken OAuth トークンを使用して、REST API にアクセスします。

YAML スクリプトから AccessToken を使用します。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
はい
CollectionId TFS コレクションまたは Azure DevOps 組織の GUID。 はい
System. CollectionUri TFS コレクションまたは Azure DevOps 組織の URI。 (例: https://dev.azure.com/fabrikamfiber/)。 はい
System.defaultworkingdirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

いいえ
DefinitionId ビルドパイプラインの ID。 はい
HostType buildパイプラインがビルドである場合はに設定します。 リリースでは、値は、 deployment 配置グループのジョブ、 gates ゲートの評価中、および release その他の (エージェントとエージェントレスの) ジョブに使用されます。 はい
JobAttempt このジョブが初めて試行されたときに1に設定され、ジョブが再試行されるたびに増分されます。 いいえ
JobDisplayName ジョブに指定されたユーザーが判読できる名前。 いいえ
システムジョブ Id 1つのジョブを1回試行するための一意の識別子。 値は、現在のパイプラインに対して一意です。 いいえ
JobName ジョブの名前。通常、依存関係を表現したり、出力変数にアクセスしたりするために使用されます。 いいえ
PhaseAttempt このフェーズが初めて試行されたときに1に設定し、ジョブが再試行されるたびに増分します。

注: "フェーズ" は、ジョブのデザイン時を表すほぼ冗長な概念です (ジョブは、フェーズのランタイムバージョンでした)。 ほとんどの場合、Azure Pipelines から "フェーズ" の概念を削除しました。 "フェーズ" が "ジョブ" とは異なる場所は、マトリックスジョブとマルチ構成ジョブだけです。 1つのフェーズでは、入力のみが異なる複数のジョブをインスタンス化できます。
いいえ
PhaseDisplayName フェーズに与えられた、ユーザーが判読できる名前。 いいえ
PhaseName ジョブの文字列ベースの識別子。通常は、依存関係を表現したり、出力変数にアクセスしたりするために使用されます。 いいえ
システム. StageAttempt このステージが初めて試行されたときに1に設定され、ジョブが再試行されるたびに増分されます。 いいえ
システム. StageDisplayName ステージに対して指定された、ユーザーが判読できる名前。 いいえ
StageName ステージの文字列ベースの識別子。通常は、依存関係を表現したり、出力変数にアクセスしたりするために使用されます。 はい
プル要求. IsFork プル要求がリポジトリのフォークからのものである場合、この変数はに設定され True ます。 それ以外の場合は、に設定され False ます。 はい
プル要求. Event.pullrequestid このビルドの原因となったプル要求の ID。 (例: 17)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。 いいえ
プル要求. PullRequestNumber このビルドの原因となったプル要求の数。 この変数は、異なるプル要求 ID とプル要求番号を持つ GitHub からのプル要求に対して設定されます。 この変数は、PR がブランチポリシーの影響を受けている場合にのみ、YAML パイプラインで使用できます。 いいえ
プル要求. SourceBranch プル要求で確認されているブランチ。 例: refs/heads/users/raisa/new-feature Azure Repos の場合。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。 この変数は、PR がブランチポリシーの影響を受ける場合にのみ、YAML パイプラインで使用できます。 いいえ
プル要求. SourceRepositoryURI プル要求が格納されているリポジトリの URL。 (例: https://dev.azure.com/ouraccount/_git/OurProject)。 いいえ
プル要求. TargetBranch プル要求のターゲットである分岐。 例: refs/heads/master リポジトリが Azure Repos にあり、 master リポジトリが GitHub にある場合。 この変数は、 ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ初期化されます。 この変数は、PR がブランチポリシーの影響を受ける場合にのみ、YAML パイプラインで使用できます。 いいえ
Teamfound Ationcollectionuri TFS コレクションまたは Azure DevOps 組織の URI。 (例: https://dev.azure.com/fabrikamfiber/)。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
はい
System.TeamProject このビルドを含むプロジェクトの名前。 はい
TeamProjectId このビルドが属しているプロジェクトの ID。 はい
TF_BUILD Trueスクリプトがビルドタスクによって実行されている場合は、に設定します。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ

変数をチェックします (DevOps Services)

変数説明
Checks.StageAttempt このステージが初めて試行された場合は 1 に設定され、ステージが再試行されるごとに増分されます。

この変数は、環境の承認 またはチェック内でのみ 使用できます。 たとえば、呼び出し $(Checks.StageAttempt) メソッド内で を使用して、 をREST APIできます

Add the stage attempt as a parameter.

エージェント変数 (DevOps Server 2020)

注意

エージェント変数は、スクリプト内の環境変数として、およびビルド タスクのパラメーターとして使用できます。 ビルド番号をカスタマイズしたり、バージョン コントロールのラベルまたはタグを適用したりするために使用することはできません。

変数説明
Agent.BuildDirectory

特定のビルド パイプラインのすべてのフォルダーが作成されるエージェントのローカル パス。 この変数の値は と同じです Pipeline.Workspace

例: /home/vsts/work/1

Agent.HomeDirectory エージェントがインストールされているディレクトリ。 これには、エージェント ソフトウェアが含まれている。 (例: c:\agent)。
Agent.Id エージェントの ID。
Agent.JobName 実行中のジョブの名前。 これは通常、 " ジョブ " または__default " " になりますが、マルチ構成シナリオでは、 が構成になります。
Agent.JobStatus ビルドの状態。
  • Canceled
  • Failed
  • Succeeded
  • SucceededWithIssues (部分的に成功)

環境変数は として参照する必要があります AGENT_JOBSTATUS 。 旧バージョン agent.jobstatus は下位互換性のために使用できます。

Agent.MachineName エージェントがインストールされているマシンの名前。
Agent.Name

プールに登録されているエージェントの名前。

セルフホステッド エージェントを使用している場合、この名前はユーザーによって指定されます。 エージェントに関するページ を参照してください

Agent.OS エージェント ホストのオペレーティング システム。 有効な値は次のとおりです。
  • Windows_NT
  • Darwin
  • Linux
コンテナーで'実行している場合、エージェント ホストとコンテナーで異なるオペレーティング システムが実行されている可能性があります。
Agent.OSArchitecture エージェント ホストのオペレーティング システム プロセッサ アーキテクチャ。 有効な値は次のとおりです。
  • X86
  • X64
  • ARM
Agent.TempDirectory

各パイプライン ジョブの後にクリーンアップされる一時フォルダー。 このディレクトリは、発行前にテスト.NET Core CLI 時的な項目を保持するタスクなどのタスクによって使用されます。

例: /home/vsts/work/_temp Ubuntu の場合

Agent.ToolsDirectory Node Toolインストーラーや Python バージョンを使用してツールの複数のバージョンを切り替えるなどのタスクで使用されるディレクトリ。 これらのタスクにより、このディレクトリから にツールが追加されます。これにより PATH 、後続のビルド手順でツールを使用できます。

セルフホ ステッド エージェント でこのディレクトリを管理する方法について学習します
Agent.WorkFolder このエージェントの作業ディレクトリ。 (例: c:\agent_work)。

注: このディレクトリは、パイプライン タスク (例: コンテナーにマップされている場合)

ビルド変数 (DevOps Server 2020)


変数説明テンプレートで使用できますか?
Build.ArtifactStagingDirectory

成果物がコピー先にプッシュされる前のエージェント上のローカル パス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ファイルのコピー]タスクと [ビルド成果物の発行] タスクを使用してビルド成果物を発行する方法です。

注: Build.ArtifactStagingDirectory と Build.StagingDirectory は交換可能です。 このディレクトリは新しいビルドの前に消去'クリーンアップする必要はありません。

「Artifacts in Azure Pipelines 」 を参照してください

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。

いいえ
Build.BuildId 完了したビルドのレコードの ID。 いいえ
Build.BuildNumber 完了したビルドの名前 (実行番号とも呼ばれる)。 この値に 含める値 を指定できます。

この変数の一般的な使用は、リポジトリ タブで指定するラベル形式の一部に することです

注: この値には、空白文字または他の無効なラベル文字を含めることができます。 このような場合、ラベル形式 失敗します。



この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。

いいえ
Build.BuildUri ビルドの URI。 (例: vstfs:///Build/Build/1430)。

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。
いいえ
Build.BinariesDirectory コンパイル済みバイナリの出力フォルダーとして使用できるエージェントのローカル パス。

既定では、新しいビルド パイプラインは、このディレクトリをクリーンアップするために設定されません。 ビルドを定義してクリーンアップするには、[リポジトリ] タブ を使用します

(例: c:\agent_work\1\b)。

この変数はエージェント スコープであり、スクリプト内の環境変数として使用したり、ビルド タスクのパラメーターとして使用したりできますが、ビルド番号の一部として使用したり、バージョンコントロール タグとして使用したりすることはできません。
いいえ
Build.ContainerId 成果物のコンテナーの ID。 パイプラインで成果物をアップロードすると、その特定の成果物に固有のコンテナーに追加されます。 いいえ
Build.DefinitionName ビルド パイプラインの名前。

注: この値には、空白文字または他の無効なラベル文字を含めることができます。 このような場合、ラベル形式 失敗します。

はい
ビルド. DefinitionVersion ビルドパイプラインのバージョン。 はい
ビルド. キュー " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

はい
QueuedById " Id 変数の設定方法を確認してください " 。 はい
ビルド。理由 ビルドの実行の原因となったイベント。
  • Manual: ユーザーがビルドを手動でキューに配置しました。
  • IndividualCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI)
  • BatchedCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI) と、 バッチ変更 が選択されました。
  • Schedule: スケジュール されたトリガー。
  • ValidateShelveset: ユーザーが特定の TFVC シェルブセットのビルドを手動でキューに配置しました。
  • CheckInShelveset: ゲートチェックイン トリガー。
  • PullRequest: ビルドは、ビルドを必要とする Git ブランチポリシーによってトリガーされました。
  • ResourceTrigger: ビルドが リソーストリガーによって トリガーされたか、 別のビルドによってトリガーされました。
ブランチポリシーを使用してコードの品質を向上させる」を参照してください。
はい
ビルドリポジトリ。クリーン ソースリポジトリの設定クリーンに選択し'した値。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
LocalPath

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。重要な注意: Git リポジトリを1つだけチェックアウトする場合、このパスはコードの正確なパスになります。 複数のリポジトリをチェックアウトすると、そのリポジトリは既定値であるに戻り $(Pipeline.Workspace)/s ます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は、ビルドの SourcesDirectory と同義です。

いいえ
Build.Repository.ID リポジトリの一意識別子。

これにより、リポジトリの名前が変更された場合でも't が変更されます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
Build.Repository.Name トリガーする リポジトリの名前。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ビルド. Repository. プロバイダー トリガーする リポジトリの種類。 この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。 いいえ
ビルド... ワークスペース リポジトリが Team Foundation バージョン管理場合に定義されます。 ビルドエージェントによって使用される TFVC ワークスペース の名前。


たとえば、エージェントの BuildDirectory がで、 c:\agent_work\12 Agent.Id がの場合、 8 ワークスペース名は次のようになります。 ws_12_8

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
Repository. Uri トリガーしているリポジトリの URL。 次に例を示します。 この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。 いいえ
のビルド requested " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

はい
ビルド. RequestedForEmail " Id 変数の設定方法を確認してください " 。 はい
ビルド. RequestedForId " Id 変数の設定方法を確認してください " 。 はい
Build.SourceBranch ビルドがキューに入れられたトリガーリポジトリの分岐。 次に例をいくつか示します。
  • Git リポジトリのブランチ: refs/heads/master
  • Git リポジトリのプル要求: refs/pull/1/merge
  • TFVC リポジトリのブランチ: $/teamproject/main
  • TFVC リポジトリゲートチェックイン: Gated_2016-06-06_05.20.51.4369;username@live.com
  • TFVC リポジトリシェルブセットのビルド: myshelveset;username@live.com
  • タグによってパイプラインがトリガーされた場合: refs/tags/your-tag-name
ビルド番号形式でこの変数を使用する場合、スラッシュ ( / ) はアンダースコア文字に置き換えられ _ ます。

注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
はい
SourceBranchName ビルドがキューに入れられたトリガーリポジトリ内の分岐の名前。
  • Git リポジトリの分岐またはプル要求: 参照の最後のパスセグメント。たとえば、 refs/heads/master この値は master です。 で refs/heads/feature/tools は、この値は tools です。
  • TFVC リポジトリの分岐: ワークスペースのルートサーバーパスの最後のパスセグメント。 たとえば、 $/teamproject/main この値は次のようになります。 main.
  • TFVC リポジトリゲートチェックインまたはシェルブセットビルドはシェルブセットの名前です。 たとえば、Gated_2016-06-06_05.20.51.4369;username@live.com または myshelveset;username@live.com です。
注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
はい
ビルド. SourcesDirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。重要な注意: Git リポジトリを1つだけチェックアウトする場合、このパスはコードの正確なパスになります。 複数のリポジトリをチェックアウトすると、そのリポジトリは既定値であるに戻り $(Pipeline.Workspace)/s ます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は LocalPath と同義です。

いいえ
ビルド SourceVersion このビルドに含まれるトリガーしているリポジトリの最新バージョンコントロールの変更。 この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。 はい
SourceVersionMessage をビルドします。 トリガーしているリポジトリのコミットまたは変更セットのコメント。 メッセージは、最初の行または200文字のいずれか短い方に切り捨てられます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。 また、この変数はステップレベルでのみ使用でき、ジョブでもステージレベルでも使用できません (つまり、ジョブが開始されてコードがチェックアウトされるまで、メッセージは抽出されません)。

注: この変数は、TFS 2015.4 で使用できます。

いいえ
Build.stagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

いいえ
ビルド. Git. SubmoduleCheckout [リポジトリ] タブで、チェックアウト用に選択した'の値 (サブモジュール)。複数のリポジトリがチェックアウトされている場合、この値はトリガーしているリポジトリの設定を追跡します。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
SourceTfvcShelveset をビルドします。 リポジトリが Team Foundation バージョン管理場合に定義されます。


ゲートビルドまたはシェルブセットビルドを実行している場合は、ビルドしているシェルブセットの名前に設定されます。

メモ: この変数は、ビルド番号形式でのビルドの使用に対して無効な値を生成します。
いいえ
BuildId を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数はトリガービルドの BuildID に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
DefinitionId を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数はトリガービルドの DefinitionID に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ビルド. DefinitionName ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガーを起動するビルドパイプラインの名前に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ビルドします。 ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガーするビルドの番号に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
ProjectID を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガービルドを含むプロジェクトの ID に設定されます。 クラシックパイプラインでは、この変数はビルド完了トリガーによってトリガーされます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ
一般的な Testのディレクトリ テスト結果が作成されるエージェントのローカルパス。 たとえば、c:\agent_work\1\TestResults のようにします。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ

パイプライン変数 (DevOps Server 2020)

変数説明
Pipeline. ワークスペース 特定のパイプラインのワークスペースディレクトリ。 この変数の値はと同じ Agent.BuildDirectory です。

たとえば、「 /home/vsts/work/1 」のように入力します。

配置ジョブ変数 (DevOps Server 2020)

これらの変数は特定の 配置ジョブ にスコープが設定され、ジョブの実行時にのみ解決されます。

変数説明
Environment.Name 配置手順を実行して配置履歴を記録する配置ジョブを対象とする環境の名前。 たとえば、「 smarthotel-dev 」のように入力します。
Environment.Id 配置ジョブを対象とする環境の ID。 たとえば、「 10 」のように入力します。
環境.......... 配置の手順を実行してデプロイの履歴を記録するために、配置ジョブの対象となる環境内の特定のリソースの名前。 たとえば、 bookings 環境にリソースとして追加された Kubernetes 名前空間です smarthotel-dev
環境. ResourceId 配置手順を実行する配置ジョブを対象とする環境内の特定のリソースの ID。 たとえば、「 4 」のように入力します。

システム変数 (DevOps Server 2020)

変数説明テンプレートで使用できますか?
AccessToken OAuth トークンを使用して、REST API にアクセスします。

YAML スクリプトから AccessToken を使用します。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
はい
CollectionId TFS コレクションまたは Azure DevOps 組織の GUID はい
System. CollectionUri コレクション URI Team Foundation Server 文字列。 はい
System.defaultworkingdirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

いいえ
DefinitionId ビルドパイプラインの ID。 はい
HostType buildパイプラインがビルドである場合はに設定します。 リリースでは、値は、 deployment 配置グループのジョブ、 gates ゲートの評価中、および release その他の (エージェントとエージェントレスの) ジョブに使用されます。 はい
JobAttempt このジョブが初めて試行されたときに1に設定され、ジョブが再試行されるたびに増分されます。 いいえ
JobDisplayName ジョブに指定されたユーザーが判読できる名前。 いいえ
システムジョブ Id 1つのジョブを1回試行するための一意の識別子。 値は、現在のパイプラインに対して一意です。 いいえ
JobName ジョブの名前。通常、依存関係を表現したり、出力変数にアクセスしたりするために使用されます。 いいえ
PhaseAttempt このフェーズが初めて試行されたときに1に設定し、ジョブが再試行されるたびに増分します。

注: "フェーズ" は、ジョブのデザイン時を表すほぼ冗長な概念です (ジョブは、フェーズのランタイムバージョンでした)。 ほとんどの場合、Azure Pipelines から "フェーズ" の概念を削除しました。 "フェーズ" が "ジョブ" とは異なる場所は、マトリックスジョブとマルチ構成ジョブだけです。 1つのフェーズでは、入力のみが異なる複数のジョブをインスタンス化できます。
いいえ
PhaseDisplayName フェーズに与えられた、ユーザーが判読できる名前。 いいえ
PhaseName ジョブの文字列ベースの識別子。通常は、依存関係を表現したり、出力変数にアクセスしたりするために使用されます。 いいえ
システム. StageAttempt このステージが初めて試行されたときに1に設定され、ジョブが再試行されるたびに増分されます。 いいえ
システム. StageDisplayName ステージに対して指定された、ユーザーが判読できる名前。 いいえ
StageName ステージの文字列ベースの識別子。通常は、依存関係を表現したり、出力変数にアクセスしたりするために使用されます。 はい
プル要求. IsFork プル要求がリポジトリのフォークからのものである場合、この変数はに設定され True ます。 それ以外の場合は、に設定され False ます。 はい
プル要求. Event.pullrequestid このビルドの原因となったプル要求の ID。 (例: 17)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。 いいえ
プル要求. PullRequestNumber このビルドの原因となったプル要求の数。 この変数は、異なるプル要求 ID とプル要求番号を持つ GitHub からのプル要求に対して設定されます。 この変数は、PR がブランチポリシーの影響を受けている場合にのみ、YAML パイプラインで使用できます。 いいえ
プル要求. SourceBranch プル要求で確認されているブランチ。 (例: refs/heads/users/raisa/new-feature)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。 この変数は、PR がブランチポリシーの影響を受ける場合にのみ、YAML パイプラインで使用できます。 いいえ
プル要求. SourceRepositoryURI プル要求が格納されているリポジトリの URL。 (例: https://dev.azure.com/ouraccount/_git/OurProject)。 いいえ
プル要求. TargetBranch プル要求のターゲットである分岐。 例: refs/heads/master リポジトリが Azure Repos にあり、 master リポジトリが GitHub にある場合。 この変数は、 ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ初期化されます。 この変数は、PR がブランチポリシーの影響を受ける場合にのみ、YAML パイプラインで使用できます。 いいえ
Teamfound Ationcollectionuri Team foundation コレクションの URI。 たとえば、https://dev.azure.com/fabrikamfiber/ のようにします。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
はい
System.TeamProject このビルドを含むプロジェクトの名前。 はい
TeamProjectId このビルドが属しているプロジェクトの ID。 はい
TF_BUILD Trueスクリプトがビルドタスクによって実行されている場合は、に設定します。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
いいえ

エージェント変数 (DevOps Server 2019)

注意

エージェント変数は、スクリプト内で環境変数として使用することも、ビルドタスクのパラメーターとして使用することもできます。 これらの値を使用して、ビルド番号をカスタマイズしたり、バージョンコントロールのラベルまたはタグを適用したりすることはできません。

変数説明
エージェントの BuildDirectory

指定されたビルドパイプラインのすべてのフォルダーが作成されるエージェントのローカルパス。

例: c:\agent_work\1

HomeDirectory エージェントがインストールされているディレクトリ。 これには、エージェントソフトウェアが含まれます。 (例: c:\agent)。
Agent.Id エージェントの ID。
JobName 実行中のジョブの名前。 これは通常 " 、Job " または " __default " ですが、複数構成のシナリオでは、が構成になります。
JobStatus ビルドの状態。
  • Canceled
  • Failed
  • Succeeded
  • SucceededWithIssues (部分的に成功)

環境変数はとして参照する必要があり AGENT_JOBSTATUS ます。 旧バージョンとの agent.jobstatus 互換性を維持するために使用できます。

エージェント. MachineName エージェントがインストールされているコンピューターの名前。
Agent.Name

プールに登録されているエージェントの名前。

自己ホスト型エージェントを使用している場合は、この名前が指定されます。 「 エージェント」を参照してください。

エージェント. OS エージェントホストのオペレーティングシステム。 次の値を指定できます。
  • Windows_NT
  • Darwin
  • Linux
コンテナーで実行し'場合、エージェントのホストとコンテナーは異なるオペレーティングシステムを実行している可能性があります。
エージェント. OSArchitecture エージェントホストのオペレーティングシステムプロセッサアーキテクチャ。 次の値を指定できます。
  • X86
  • X64
  • ARM
Agent. TempDirectory 各パイプラインジョブの後に消去される一時フォルダー。 このディレクトリは、発行前にテスト結果などの一時項目を保持するために、 .NET Core CLI タスク などのタスクによって使用されます。
エージェント.? ディレクトリ ノードツールインストーラーなどのタスクによって使用されるディレクトリ。 Python バージョンを使用して、複数のバージョンのツールを切り替えます。 これらのタスクは、このディレクトリからにツールを追加し PATH て、後続のビルドステップでそれらを使用できるようにします。

自己ホスト型エージェントでのこのディレクトリの管理について説明します。
エージェント. ワークフォルダー このエージェントの作業ディレクトリ。 (例: c:\agent_work)。

このディレクトリは、パイプラインタスクによって書き込み可能であるとは限りません (例 コンテナーにマップされている場合)

ビルド変数 (DevOps Server 2019)


変数説明
Build.artifactstagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

BuildId 完了したビルドのレコードの ID。
ビルドします。 完了したビルドの名前。 パイプラインオプションでこの値を生成するビルド番号の形式を指定できます。

この変数の一般的な用途は、[ リポジトリ] タブで指定するラベル形式の一部にすることです。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。



この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

BuildUri ビルドの URI。 (例: vstfs:///Build/Build/1430)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
BinariesDirectory コンパイルされたバイナリの出力フォルダーとして使用できるエージェントのローカルパス。

既定では、新しいビルドパイプラインは、このディレクトリを消去するように設定されていません。 [ リポジトリ] タブでビルドをクリーンアップするように定義できます。

(例: c:\agent_work\1\b)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. DefinitionName ビルドパイプラインの名前。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. DefinitionVersion ビルドパイプラインのバージョン。
ビルド. キュー " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

QueuedById " Id 変数の設定方法を確認してください " 。
ビルド。理由 ビルドの実行の原因となったイベント。
  • Manual: ユーザーがビルドを手動でキューに配置しました。
  • IndividualCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI)
  • BatchedCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI) と、 バッチ変更 が選択されました。
  • Schedule: スケジュール されたトリガー。
  • ValidateShelveset: ユーザーが特定の TFVC シェルブセットのビルドを手動でキューに配置しました。
  • CheckInShelveset: ゲートチェックイン トリガー。
  • PullRequest: ビルドは、ビルドを必要とする Git ブランチポリシーによってトリガーされました。
  • BuildCompletion: ビルドは別のビルドによってトリガーされました
ブランチポリシーを使用してコードの品質を向上させる」を参照してください。
ビルドリポジトリ。クリーン ソースリポジトリの設定クリーンに選択し'した値。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
LocalPath

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は、ビルドの SourcesDirectory と同義です。

Build.Repository.Name リポジトリの名前。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. Repository. プロバイダー 選択した リポジトリの種類。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド... ワークスペース リポジトリが Team Foundation バージョン管理場合に定義されます。 ビルドエージェントによって使用される TFVC ワークスペース の名前。


たとえば、エージェントの BuildDirectory がで、 c:\agent_work\12 Agent.Id がの場合、 8 ワークスペース名は次のようになります。 ws_12_8

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
Repository. Uri リポジトリの URL。 次に例を示します。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
のビルド requested " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. RequestedForEmail " Id 変数の設定方法を確認してください " 。
ビルド. RequestedForId " Id 変数の設定方法を確認してください " 。
SourceBranch の作成 ビルドがキューに入れられたブランチ。 次に例をいくつか示します。
  • Git リポジトリのブランチ: refs/heads/master
  • Git リポジトリのプル要求: refs/pull/1/merge
  • TFVC リポジトリのブランチ: $/teamproject/main
  • TFVC リポジトリゲートチェックイン: Gated_2016-06-06_05.20.51.4369;username@live.com
  • TFVC リポジトリシェルブセットのビルド: myshelveset;username@live.com
ビルド番号形式でこの変数を使用する場合、スラッシュ ( / ) はアンダースコア文字に置き換えられ _ ます。

注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
SourceBranchName ビルドがキューに登録されたブランチの名前。
  • Git リポジトリの分岐またはプル要求: 参照の最後のパスセグメント。たとえば、 refs/heads/master この値は master です。 で refs/heads/feature/tools は、この値は tools です。
  • TFVC リポジトリの分岐: ワークスペースのルートサーバーパスの最後のパスセグメント。 たとえば、 $/teamproject/main この値は次のようになります。 main.
  • TFVC リポジトリゲートチェックインまたはシェルブセットビルドはシェルブセットの名前です。 たとえば、Gated_2016-06-06_05.20.51.4369;username@live.com または myshelveset;username@live.com です。
注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
ビルド. SourcesDirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は LocalPath と同義です。

ビルド SourceVersion このビルドに含まれている最新バージョンコントロールの変更。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceVersionMessage をビルドします。 コミットまたは変更セットのコメント。 メッセージは、最初の行または200文字のいずれか短い方に切り捨てられます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

注: この変数は、TFS 2015.4 で使用できます。

Build.stagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

ビルド. Git. SubmoduleCheckout [リポジトリ] タブで、チェックアウト用に選択した'の値 (サブモジュール)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceTfvcShelveset をビルドします。 リポジトリが Team Foundation バージョン管理場合に定義されます。


ゲートビルドまたはシェルブセットビルドを実行している場合は、ビルドしているシェルブセットの名前に設定されます。

メモ: この変数は、ビルド番号形式でのビルドの使用に対して無効な値を生成します。
BuildId を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数はトリガービルドの BuildID に設定されます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
DefinitionId を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数はトリガービルドの DefinitionID に設定されます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. DefinitionName ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガーを起動するビルドパイプラインの名前に設定されます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルドします。 ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガーするビルドの番号に設定されます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ProjectID を作成します。 ビルドが別の ビルドによってトリガーされた場合、この変数は、トリガービルドを含むプロジェクトの ID に設定されます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
一般的な Testのディレクトリ テスト結果が作成されるエージェントのローカルパス。 たとえば、c:\agent_work\1\TestResults のようにします。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

システム変数 (DevOps Server 2019)

変数説明
AccessToken OAuth トークンを使用して、REST API にアクセスします。

YAML スクリプトから AccessToken を使用します。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
CollectionId TFS コレクションまたは Azure DevOps 組織の GUID
System.defaultworkingdirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

DefinitionId ビルドパイプラインの ID。
HostType buildパイプラインがビルドである場合はに設定します。 リリースでは、 deployment 展開グループジョブとエージェントジョブの値が使用され release ます。
プル要求. IsFork プル要求がリポジトリのフォークからのものである場合、この変数はに設定され True ます。 それ以外の場合は、に設定され False ます。
プル要求. Event.pullrequestid このビルドの原因となったプル要求の ID。 (例: 17)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. PullRequestNumber このビルドの原因となったプル要求の数。 この変数は、異なるプル要求 ID とプル要求番号を持つ GitHub からのプル要求に対して設定されます。
プル要求. SourceBranch プル要求で確認されているブランチ。 (例: refs/heads/users/raisa/new-feature)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceRepositoryURI プル要求が格納されているリポジトリの URL。 (例: https://dev.azure.com/ouraccount/_git/OurProject)。 (この変数は、 ブランチポリシーの影響を受けた Azure Repos GIT PRが原因でビルドが実行された場合にのみ初期化されます。 GitHub Pr では初期化されていません)。
プル要求. TargetBranch プル要求のターゲットである分岐。 (例: refs/heads/master)。 この変数は、 ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ初期化されます。
Teamfound Ationcollectionuri Team foundation コレクションの URI。 (例: https://dev.azure.com/fabrikamfiber/)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
System.TeamProject このビルドを含むプロジェクトの名前。
TeamProjectId このビルドが属しているプロジェクトの ID。
TF_BUILD Trueスクリプトがビルドタスクによって実行されている場合は、に設定します。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

エージェントの変数 (TFS 2018)

注意

エージェント変数は、スクリプト内で環境変数として使用することも、ビルドタスクのパラメーターとして使用することもできます。 これらの値を使用して、ビルド番号をカスタマイズしたり、バージョンコントロールのラベルまたはタグを適用したりすることはできません。

変数説明
エージェントの BuildDirectory

指定されたビルドパイプラインのすべてのフォルダーが作成されるエージェントのローカルパス。

例: c:\agent_work\1

HomeDirectory エージェントがインストールされているディレクトリ。 これには、エージェントソフトウェアが含まれます。 (例: c:\agent)。
Agent.Id エージェントの ID。
JobStatus ビルドの状態。
  • Canceled
  • Failed
  • Succeeded
  • SucceededWithIssues (部分的に成功)

環境変数はとして参照する必要があり AGENT_JOBSTATUS ます。 旧バージョンとの agent.jobstatus 互換性を維持するために使用できます。

エージェント. MachineName エージェントがインストールされているコンピューターの名前。
Agent.Name

プールに登録されているエージェントの名前。

この名前は、ユーザーが指定します。 「 エージェント」を参照してください。

Agent. TempDirectory 各パイプラインジョブの後に消去される一時フォルダー。 このディレクトリは、発行前にテスト結果などの一時項目を保持するために、 .NET Core CLI タスク などのタスクによって使用されます。
エージェント.? ディレクトリ ノードツールインストーラーなどのタスクによって使用されるディレクトリ。 Python バージョンを使用して、複数のバージョンのツールを切り替えます。 これらのタスクは、このディレクトリからにツールを追加し PATH て、後続のビルドステップでそれらを使用できるようにします。

自己ホスト型エージェントでのこのディレクトリの管理について説明します。
エージェント. ワークフォルダー このエージェントの作業ディレクトリ。 (例: c:\agent_work)。

変数のビルド (TFS 2018)


変数説明
Build.artifactstagingdirectory ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

BuildId 完了したビルドのレコードの ID。
ビルドします。 完了したビルドの名前。 パイプラインオプションでこの値を生成するビルド番号の形式を指定できます。

この変数の一般的な用途は、[ リポジトリ] タブで指定するラベル形式の一部にすることです。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。



この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、バージョン管理タグとしては使用できません。

BuildUri ビルドの URI。 (例: vstfs:///Build/Build/1430)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
BinariesDirectory コンパイルされたバイナリの出力フォルダーとして使用できるエージェントのローカルパス。

既定では、新しいビルドパイプラインは、このディレクトリを消去するように設定されていません。 [ リポジトリ] タブでビルドをクリーンアップするように定義できます。

(例: c:\agent_work\1\b)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. DefinitionName ビルドパイプラインの名前。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. DefinitionVersion ビルドパイプラインのバージョン。
ビルド. キュー " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

QueuedById " Id 変数の設定方法を確認してください " 。
ビルド。理由 ビルドの実行の原因となったイベント。
  • Manual: ユーザーが UI または API 呼び出しからビルドを手動でキューに入れました。
  • IndividualCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI)
  • BatchedCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI) と、 バッチ変更 が選択されました。
  • Schedule: スケジュール されたトリガー。
  • ValidateShelveset: ユーザーが特定の TFVC シェルブセットのビルドを手動でキューに配置しました。
  • CheckInShelveset: ゲートチェックイン トリガー。
  • PullRequest: ビルドは、ビルドを必要とする Git ブランチポリシーによってトリガーされました。
ブランチポリシーを使用してコードの品質を向上させる」を参照してください。
ビルドリポジトリ。クリーン ソースリポジトリの設定クリーンに選択し'した値。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
LocalPath

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は、ビルドの SourcesDirectory と同義です。

Build.Repository.Name リポジトリの名前。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. Repository. プロバイダー 選択した リポジトリの種類。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド... ワークスペース リポジトリが Team Foundation バージョン管理場合に定義されます。 ビルドエージェントによって使用される TFVC ワークスペース の名前。

たとえば、エージェントの BuildDirectory がで、 c:\agent_work\12 Agent.Id がの場合、 8 ワークスペース名は次のようになります。 ws_12_8

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
Repository. Uri リポジトリの URL。 次に例を示します。
  • Git https://fabrikamfiber/tfs/DefaultCollection/Scripts/_git/Scripts
  • TFVC https://fabrikamfiber/tfs/DefaultCollection/
この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
のビルド requested " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. RequestedForEmail " Id 変数の設定方法を確認してください " 。
ビルド. RequestedForId " Id 変数の設定方法を確認してください " 。
SourceBranch の作成 ビルドがキューに入れられたブランチ。 次に例をいくつか示します。
  • Git リポジトリのブランチ: refs/heads/master
  • Git リポジトリのプル要求: refs/pull/1/merge
  • TFVC リポジトリのブランチ: $/teamproject/main
  • TFVC リポジトリゲートチェックイン: Gated_2016-06-06_05.20.51.4369;username@live.com
  • TFVC リポジトリシェルブセットのビルド: myshelveset;username@live.com
ビルド番号形式でこの変数を使用する場合、スラッシュ ( / ) はアンダースコア文字に置き換えられ _ ます。

注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
SourceBranchName ビルドがキューに登録されたブランチの名前。
  • Git リポジトリの分岐またはプル要求: 参照の最後のパスセグメント。たとえば、 refs/heads/master この値は master です。 で refs/heads/feature/tools は、この値は tools です。
  • TFVC リポジトリの分岐: ワークスペースのルートサーバーパスの最後のパスセグメント。 たとえば、 $/teamproject/main この値は次のようになります。 main.
  • TFVC リポジトリゲートチェックインまたはシェルブセットビルドはシェルブセットの名前です。 たとえば、Gated_2016-06-06_05.20.51.4369;username@live.com または myshelveset;username@live.com です。
注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
ビルド. SourcesDirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は LocalPath と同義です。

ビルド SourceVersion このビルドに含まれている最新バージョンコントロールの変更。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceVersionMessage をビルドします。 コミットまたは変更セットのコメント。 メッセージは、最初の行または200文字のいずれか短い方に切り捨てられます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

注: この変数は、TFS 2015.4 で使用できます。

Build.stagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

ビルド. Git. SubmoduleCheckout [リポジトリ] タブで、チェックアウト用に選択した'の値 (サブモジュール)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceTfvcShelveset をビルドします。 リポジトリが Team Foundation バージョン管理場合に定義されます。

ゲートビルドまたはシェルブセットビルドを実行している場合は、ビルドしているシェルブセットの名前に設定されます。

メモ: この変数は、ビルド番号形式でのビルドの使用に対して無効な値を生成します。
一般的な Testのディレクトリ テスト結果が作成されるエージェントのローカルパス。 たとえば、c:\agent_work\1\TestResults のようにします。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

システム変数 (TFS 2018)

変数説明
AccessToken OAuth トークンを使用して、REST API にアクセスします。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
CollectionId TFS コレクションまたは Azure DevOps 組織の GUID
System.defaultworkingdirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

DefinitionId ビルドパイプラインの ID。
HostType buildパイプラインがビルドである場合、または release パイプラインがリリースである場合は、をに設定します。
プル要求. IsFork プル要求がリポジトリのフォークからのものである場合、この変数はに設定され True ます。 それ以外の場合は、に設定され False ます。 TFS 2018.2で使用できます。
プル要求. Event.pullrequestid このビルドの原因となったプル要求の ID。 (例: 17)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceBranch プル要求で確認されているブランチ。 (例: refs/heads/users/raisa/new-feature)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceRepositoryURI プル要求が格納されているリポジトリの URL。 (例: http://our-server:8080/tfs/DefaultCollection/_git/OurProject)。 (この変数は、 ブランチポリシーの影響を受けた Azure Repos GIT PRが原因でビルドが実行された場合にのみ初期化されます)。
プル要求. TargetBranch プル要求のターゲットである分岐。 (例: refs/heads/master)。 この変数は、 ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ初期化されます。
Teamfound Ationcollectionuri Team foundation コレクションの URI。 (例: http://our-server:8080/tfs/DefaultCollection/)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
System.TeamProject このビルドを含むプロジェクトの名前。
TeamProjectId このビルドが属しているプロジェクトの ID。
TF_BUILD Trueスクリプトがビルドタスクによって実行されている場合は、に設定します。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

エージェントの変数 (TFS 2017)

注意

エージェント変数は、スクリプト内で環境変数として使用することも、ビルドタスクのパラメーターとして使用することもできます。 これらの値を使用して、ビルド番号をカスタマイズしたり、バージョンコントロールのラベルまたはタグを適用したりすることはできません。

変数説明
エージェントの BuildDirectory

指定されたビルドパイプラインのすべてのフォルダーが作成されるエージェントのローカルパス。

例: c:\agent_work\1

エージェント. ComputerName エージェントがインストールされているコンピューターの名前。
HomeDirectory エージェントがインストールされているディレクトリ。 これには、エージェントソフトウェアが含まれます。 (例: c:\agent)。
Agent.Id エージェントの ID。
JobStatus ビルドの状態。
  • Canceled
  • Failed
  • Succeeded
  • SucceededWithIssues (部分的に成功)

環境変数はとして参照する必要があり AGENT_JOBSTATUS ます。 旧バージョンとの agent.jobstatus 互換性を維持するために使用できます。

Agent.Name

プールに登録されているエージェントの名前。

この名前は、ユーザーが指定します。 「 エージェント」を参照してください。

エージェント. ワークフォルダー このエージェントの作業ディレクトリ。 (例: c:\agent_work)。

変数のビルド (TFS 2017)


変数説明
Build.artifactstagingdirectory ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

BuildId 完了したビルドのレコードの ID。
ビルドします。 完了したビルドの名前。 パイプラインオプションでこの値を生成するビルド番号の形式を指定できます。

この変数の一般的な用途は、[ リポジトリ] タブで指定するラベル形式の一部にすることです。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。



この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、バージョン管理タグとしては使用できません。

BuildUri ビルドの URI。 (例: vstfs:///Build/Build/1430)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
BinariesDirectory コンパイルされたバイナリの出力フォルダーとして使用できるエージェントのローカルパス。

既定では、新しいビルドパイプラインは、このディレクトリを消去するように設定されていません。 [ リポジトリ] タブでビルドをクリーンアップするように定義できます。

(例: c:\agent_work\1\b)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. DefinitionName ビルドパイプラインの名前。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. DefinitionVersion ビルドパイプラインのバージョン。
ビルド. キュー " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

QueuedById " Id 変数の設定方法を確認してください " 。
ビルド。理由 ビルドの実行の原因となったイベント。 TFS 2017.3で使用できます。
  • Manual: ユーザーがビルドを手動でキューに配置しました。
  • IndividualCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI)
  • BatchedCI: Git push または TFVC チェックインによってトリガーされる 継続的インテグレーション (CI) と、 バッチ変更 が選択されました。
  • Schedule: スケジュール されたトリガー。
  • ValidateShelveset: ユーザーが特定の TFVC シェルブセットのビルドを手動でキューに配置しました。
  • CheckInShelveset: ゲートチェックイン トリガー。
  • PullRequest: ビルドは、ビルドを必要とする Git ブランチポリシーによってトリガーされました。
ブランチポリシーを使用してコードの品質を向上させる」を参照してください。
ビルドリポジトリ。クリーン ソースリポジトリの設定クリーンに選択し'した値。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
LocalPath

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は、ビルドの SourcesDirectory と同義です。

Build.Repository.Name リポジトリの名前。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. Repository. プロバイダー 選択した リポジトリの種類。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド... ワークスペース リポジトリが Team Foundation バージョン管理場合に定義されます。 ビルドエージェントによって使用される TFVC ワークスペース の名前。

たとえば、エージェントの BuildDirectory がで、 c:\agent_work\12 Agent.Id がの場合、 8 ワークスペース名は次のようになります。 ws_12_8

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
Repository. Uri リポジトリの URL。 次に例を示します。
  • Git https://fabrikamfiber/tfs/DefaultCollection/Scripts/_git/Scripts
  • TFVC https://fabrikamfiber/tfs/DefaultCollection/
この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
のビルド requested " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. RequestedForEmail " Id 変数の設定方法を確認してください " 。
ビルド. RequestedForId " Id 変数の設定方法を確認してください " 。
SourceBranch の作成 ビルドがキューに入れられたブランチ。 次に例をいくつか示します。
  • Git リポジトリのブランチ: refs/heads/master
  • Git リポジトリのプル要求: refs/pull/1/merge
  • TFVC リポジトリのブランチ: $/teamproject/main
  • TFVC リポジトリゲートチェックイン: Gated_2016-06-06_05.20.51.4369;username@live.com
  • TFVC リポジトリシェルブセットのビルド: myshelveset;username@live.com
ビルド番号形式でこの変数を使用する場合、スラッシュ ( / ) はアンダースコア文字に置き換えられ _ ます。

注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
SourceBranchName ビルドがキューに登録されたブランチの名前。
  • Git リポジトリの分岐またはプル要求: 参照の最後のパスセグメント。たとえば、 refs/heads/master この値は master です。 で refs/heads/feature/tools は、この値は tools です。
  • TFVC リポジトリの分岐: ワークスペースのルートサーバーパスの最後のパスセグメント。 たとえば、 $/teamproject/main この値は次のようになります。 main.
  • TFVC リポジトリゲートチェックインまたはシェルブセットビルドはシェルブセットの名前です。 たとえば、Gated_2016-06-06_05.20.51.4369;username@live.com または myshelveset;username@live.com です。
注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
ビルド. SourcesDirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は LocalPath と同義です。

ビルド SourceVersion このビルドに含まれている最新バージョンコントロールの変更。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceVersionMessage をビルドします。 コミットまたは変更セットのコメント。 メッセージは、最初の行または200文字のいずれか短い方に切り捨てられます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

注: この変数は、TFS 2015.4 で使用できます。

Build.stagingdirectory

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 例: c:\agent_work\1\a

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。

注: Build.artifactstagingdirectory と Build.stagingdirectory は交換できます。 このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

Azure Pipelines のアーティファクトを参照してください。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

ビルド. Git. SubmoduleCheckout [リポジトリ] タブで、チェックアウト用に選択した'の値 (サブモジュール)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceTfvcShelveset をビルドします。 リポジトリが Team Foundation バージョン管理場合に定義されます。

ゲートビルドまたはシェルブセットビルドを実行している場合は、ビルドしているシェルブセットの名前に設定されます。

メモ: この変数は、ビルド番号形式でのビルドの使用に対して無効な値を生成します。
一般的な Testのディレクトリ テスト結果が作成されるエージェントのローカルパス。 たとえば、c:\agent_work\1\TestResults のようにします。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

システム変数 (TFS 2017)

変数説明
AccessToken OAuth トークンを使用して、REST API にアクセスします。
CollectionId TFS コレクションまたは Azure DevOps 組織の GUID
System.defaultworkingdirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

DefinitionId ビルドパイプラインの ID。
HostType buildパイプラインがビルドである場合、または release パイプラインがリリースである場合は、をに設定します。
プル要求. Event.pullrequestid このビルドの原因となったプル要求の ID。 (例: 17)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceBranch プル要求で確認されているブランチ。 (例: refs/heads/users/raisa/new-feature)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceRepositoryURI プル要求が格納されているリポジトリの URL。 (例: http://our-server:8080/tfs/DefaultCollection/_git/OurProject)。 (この変数は、 ブランチポリシーの影響を受けた Azure Repos GIT PRが原因でビルドが実行された場合にのみ初期化されます)。
プル要求. TargetBranch プル要求のターゲットである分岐。 (例: refs/heads/master)。 この変数は、 ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ初期化されます。
Teamfound Ationcollectionuri Team foundation コレクションの URI。 (例: http://our-server:8080/tfs/DefaultCollection/)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
System.TeamProject このビルドを含むプロジェクトの名前。
TeamProjectId このビルドが属しているプロジェクトの ID。
TF_BUILD Trueスクリプトがビルドタスクによって実行されている場合は、に設定します。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

エージェントの変数 (TFS 2015)

注意

エージェント変数は、スクリプト内で環境変数として使用することも、ビルドタスクのパラメーターとして使用することもできます。 これらの値を使用して、ビルド番号をカスタマイズしたり、バージョンコントロールのラベルまたはタグを適用したりすることはできません。

変数説明
エージェントの BuildDirectory

指定されたビルドパイプラインのすべてのフォルダーが作成されるエージェントのローカルパス。

次に例を示します。

  • TFS 2015.4: C:\TfsData\Agents\Agent-MACHINENAME_work\1
  • TFS 2015 RTM ユーザーがインストールしたエージェント: C:\Agent_work\6c3842c6
  • TFS 2015 RTM 組み込みエージェント: C:\TfsData\Build_work\6c3842c6
HomeDirectory

エージェントがインストールされているディレクトリ。 これには、エージェントソフトウェアが含まれます。

次に例を示します。

  • TFS 2015.4: C:\TfsData\Agents\Agent-MACHINENAME
  • TFS 2015 RTM ユーザーがインストールしたエージェント: C:\Agent
  • TFS 2015 RTM 組み込みエージェント: C:\Program Files\Microsoft Team Foundation Server 14.0\Build
Agent.Id エージェントの ID。
JobStatus ビルドの状態。
  • Canceled
  • Failed
  • Succeeded
  • SucceededWithIssues (部分的に成功)

注: 環境変数は、としてのみ参照でき agent.jobstatus ます。 AGENT_JOBSTATUS が TFS 2015 に存在しませんでした。

エージェント. MachineName エージェントがインストールされているコンピューターの名前。 この変数は、tfs 2015 RTMではなく、 tfs 2015.4で使用できます。
Agent.Name

プールに登録されているエージェントの名前。

この名前は、ユーザーが指定します。 「 エージェント」を参照してください。

エージェント. ワークフォルダー このエージェントの作業ディレクトリ。 (例: c:\agent_work)。

変数のビルド (TFS 2015)


変数説明
Build.artifactstagingdirectory ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。 Azure Pipelines のアーティファクトを参照してください。

次に例を示します。
  • TFS 2015.4: C:\TfsData\Agents\Agent-MACHINENAME_work\1\a
  • TFS 2015 RTM の既定のエージェント: C:\TfsData\Build_work\6c3842c6\artifacts
  • TFS 2015 RTM エージェントは、次のユーザーによってインストールされます。 C:\Agent_work\6c3842c6\artifacts
このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

TFS 2015.4では、Build.artifactstagingdirectory と build.stagingdirectory を交換できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
BuildId 完了したビルドのレコードの ID。
ビルドします。 完了したビルドの名前。 パイプラインオプションでこの値を生成するビルド番号の形式を指定できます。

この変数の一般的な用途は、[ リポジトリ] タブで指定するラベル形式の一部にすることです。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、バージョン管理タグの一部としては使用できません。

BuildUri ビルドの URI。 (例: vstfs:///Build/Build/1430)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
BinariesDirectory コンパイルされたバイナリの出力フォルダーとして使用できるエージェントのローカルパス。 TFS 2015.4で使用できます。

既定では、新しいビルドパイプラインは、このディレクトリを消去するように設定されていません。 [ リポジトリ] タブでビルドをクリーンアップするように定義できます。

たとえば、C:\TfsData\Agents\Agent-MACHINENAME_work\1\b のようにします。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. DefinitionName ビルドパイプラインの名前。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. DefinitionVersion ビルドパイプラインのバージョン。
ビルド. キュー " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

QueuedById " Id 変数の設定方法を確認してください " 。
ビルドリポジトリ。クリーン ソースリポジトリの設定クリーンに選択し'した値。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
LocalPath

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は、ビルドの SourcesDirectory と同義です。

Build.Repository.Name リポジトリの名前。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. Repository. プロバイダー 選択した リポジトリの種類。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド... ワークスペース リポジトリが Team Foundation バージョン管理場合に定義されます。 ビルドエージェントによって使用される TFVC ワークスペース の名前。

たとえば、エージェントの BuildDirectory がで、 c:\agent_work\12 Agent.Id がの場合、 8 ワークスペース名は次のようになります。 ws_12_8

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
Repository. Uri リポジトリの URL。 次に例を示します。
  • Git https://fabrikamfiber/tfs/DefaultCollection/Scripts/_git/Scripts
  • TFVC https://fabrikamfiber/tfs/DefaultCollection/
この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
のビルド requested " Id 変数の設定方法を確認してください " 。

注: この値には、空白またはその他の無効なラベル文字を含めることができます。 このような場合、 ラベルの形式 は失敗します。

ビルド. RequestedForId " Id 変数の設定方法を確認してください " 。
SourceBranch の作成 ビルドがキューに入れられたブランチ。 次に例をいくつか示します。
  • Git リポジトリのブランチ: refs/heads/master
  • Git リポジトリのプル要求: refs/pull/1/merge
  • TFVC リポジトリのブランチ: $/teamproject/main
  • TFVC リポジトリゲートチェックイン: Gated_2016-06-06_05.20.51.4369;username@live.com
  • TFVC リポジトリシェルブセットのビルド: myshelveset;username@live.com
ビルド番号形式でこの変数を使用する場合、スラッシュ ( / ) はアンダースコア文字に置き換えられ _ ます。

注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
SourceBranchName ビルドがキューに登録されたブランチの名前。
  • Git リポジトリの分岐またはプル要求: 参照の最後のパスセグメント。たとえば、 refs/heads/master この値は master です。 で refs/heads/feature/tools は、この値は tools です。
  • TFVC リポジトリの分岐: ワークスペースのルートサーバーパスの最後のパスセグメント。 たとえば、 $/teamproject/main この値は次のようになります。 main.
  • TFVC リポジトリゲートチェックインまたはシェルブセットビルドはシェルブセットの名前です。 たとえば、Gated_2016-06-06_05.20.51.4369;username@live.com または myshelveset;username@live.com です。
注: TFVC で、ゲートチェックインビルドを実行している場合、または手動でシェルブセットをビルドしている場合は、ビルド番号形式でこの変数を使用することはできません。
ビルド. SourcesDirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [ リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

この変数は LocalPath と同義です。

SourcesDirectoryHash をビルドします。 注: この変数は TFS 2015 RTM では使用できますが、TFS 2015.4 では使用できません。
ビルド SourceVersion このビルドに含まれている最新バージョンコントロールの変更。 この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceVersionMessage をビルドします。 コミットまたは変更セットのコメント。 メッセージは、最初の行または200文字のいずれか短い方に切り捨てられます。

この変数はエージェントスコープであり、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

注: この変数は、TFS 2015.4 で使用できます。

Build.stagingdirectory TFS 2015 RTM

コンパイルされたバイナリの出力フォルダーとして使用できるエージェントのローカルパス。 (例: C:\TfsData\Build_work\6c3842c6\staging)。

既定では、新しいビルドパイプラインは、このディレクトリを消去するように設定されていません。 [ リポジトリ] タブでビルドをクリーンアップするように定義できます。

TFS 2015.4

ターゲットにプッシュされる前に、成果物がコピーされるエージェントのローカルパス。 たとえば、C:\TfsData\Agents\Agent-MACHINENAME_work\1\a のようにします。

このディレクトリは、新しいビルドの前に消去されるので、自分でクリーンアップする必要は'ありません。

このフォルダーを使用する一般的な方法は、[ ファイルのコピー ] と [ ビルド成果物の発行 ] タスクを使用してビルド成果物を発行することです。 Azure Pipelines のアーティファクトを参照してください。

TFS 2015.4では、Build.artifactstagingdirectory と build.stagingdirectory を交換できます。

TFS 2015 のすべてのバージョン

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
ビルド. Git. SubmoduleCheckout [リポジトリ] タブで、チェックアウト用に選択した'の値 (サブモジュール)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
SourceTfvcShelveset をビルドします。 リポジトリが Team Foundation バージョン管理場合に定義されます。

ゲートビルドまたはシェルブセットビルドを実行している場合は、ビルドしているシェルブセットの名前に設定されます。

メモ: この変数は、ビルド番号形式でのビルドの使用に対して無効な値を生成します。
一般的な Testのディレクトリ テスト結果が作成されるエージェントのローカルパス。 (例: c:\agent_work\1\TestResults)。 TFS 2015.4 で使用できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

システム変数 (TFS 2015)

変数説明
AccessToken TFS 2015.4で使用できます。 OAuth トークンを使用して、REST API にアクセスします。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
CollectionId TFS コレクションまたは Azure DevOps 組織の GUID
System.defaultworkingdirectory

ソースコードファイルがダウンロードされるエージェントのローカルパス。 例: c:\agent_work\1\s

既定では、新しいビルドパイプラインは、変更されたファイルのみを更新します。 [リポジトリ] タブでファイルのダウンロード方法を変更できます。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

DefinitionId ビルドパイプラインの ID。
HostType buildパイプラインがビルドである場合、または release パイプラインがリリースである場合は、をに設定します。
プル要求. Event.pullrequestid このビルドの原因となったプル要求の ID。 (例: 17)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceBranch プル要求で確認されているブランチ。 (例: refs/heads/users/raisa/new-feature)。 ( ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ、この変数が初期化されます)。
プル要求. SourceRepositoryURI プル要求が格納されているリポジトリの URL。 (例: http://our-server:8080/tfs/DefaultCollection/_git/OurProject)。 (この変数は、 ブランチポリシーの影響を受けた Azure Repos GIT PRが原因でビルドが実行された場合にのみ初期化されます)。
プル要求. TargetBranch プル要求のターゲットである分岐。 (例: refs/heads/master)。 この変数は、 ブランチポリシーの影響を受ける GIT PRが原因でビルドが実行された場合にのみ初期化されます。
Teamfound Ationcollectionuri Team foundation コレクションの URI。 (例: http://our-server:8080/tfs/DefaultCollection/)。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。
System.TeamProject このビルドを含むプロジェクトの名前。
TeamProjectId このビルドが属しているプロジェクトの ID。
TF_BUILD Trueスクリプトがビルドタスクによって実行されている場合は、に設定します。

この変数はエージェントスコープです。 これは、スクリプト内では環境変数として、ビルドタスクではパラメーターとして使用できますが、ビルド番号の一部またはバージョン管理タグとして使用することはできません。

Id 変数はどのように設定されますか。

値は、ビルドの原因によって異なります。

ビルドがトリガーされた場合... 次に、QueuedById 値の基になる... 次に、のビルド. RequestedForId の値は...
継続的インテグレーション (CI) トリガーによる Git または TFVC システム id。次に例を示します。 [DefaultCollection]\Project Collection Service Accounts 変更をプッシュまたはチェックインしたユーザー。
Git または ブランチポリシーのビルド システム id。次に例を示します。 [DefaultCollection]\Project Collection Service Accounts 変更をチェックインしたユーザー。
TFVC での ゲートチェックイントリガー 変更をチェックインしたユーザー。 変更をチェックインしたユーザー。
スケジュールされたトリガーによる Git または TFVC システム id。次に例を示します。 [DefaultCollection]\Project Collection Service Accounts システム id。次に例を示します。 [DefaultCollection]\Project Collection Service Accounts
[ ビルドをキューに作成 ] ボタンをクリックしたため 自分 自分