预定义构建参数列表

预定义的服务器构建参数

这些参数是在特定构建的范围内在服务器端生成的 - 例如，构建号。

服务器构建参数通常以系统属性和相应的环境变量的形式可用。

system.teamcity.version   |   env.TEAMCITY_VERSION

TeamCity 服务器的版本。 这个属性可以用来判断构建是否在 TeamCity 中运行。

system.teamcity.projectName   |   env.TEAMCITY_PROJECT_NAME

当前构建所属的项目名称。

system.teamcity.buildConfName   |   env.TEAMCITY_BUILDCONF_NAME

当前构建所属的构建配置的名称。

system.teamcity.buildType.id

TeamCity 使用 唯一 ID 来引用当前构建所属的构建配置。

system.teamcity.configuration.properties.file

包含所有按字母顺序排列的构建参数的文件的全名（包括路径）。 当构建过程开始时，会编写此文件，并使用 Java 属性文件格式 （例如，特殊字符将以反斜杠转义）。 另请参阅： build.properties.file

system.build.is.personal   |   env.BUILD_IS_PERSONAL

返回 true 用于 个人构建。 对于常规构建，未定义（不存在）。

system.build.number   |   env.BUILD_NUMBER

由TeamCity分配给生成的生成号。 参数采用特殊的 构建编号格式。

env.BUILD_URL

当前构建的链接。

system.teamcity.build.id

TeamCity 用于引用构建的内部唯一 ID。

teamcity.build.responsibleNode.id

在 multinode setup中，此参数返回其附加的节点。 可以在发送日志记录 REST API 请求到 /app/rest/builds/id:build_id/log 端点时分配给 X-TeamCity-Node-Id-Cookie cookie。

system.teamcity.auth.userId

生成的用户名，可用于 下载其他构建配置的工件。 仅在构建期间有效。 参见此部分获取更多信息： 构建级别的身份验证。

系统团队城市认证密码

生成的密码，可用于 下载其他构建配置的工件。 仅在构建期间有效。 参见此部分获取更多信息： 构建级别的身份验证。

system.build.vcs.number.<VCS_root_ID>   |   env.BUILD_VCS_NUMBER_<VCS_root_ID>

包含在指定根的生成中的最新VCS修订。 有关 VCS 根 ID 的更多信息，请参阅以下文章： 配置 VCS 根.

如果构建配置只有一个 VCS 根，您可以使用 build.vcs.number 参数而不使用根 ID 标识符。

该值是 VCS 特有的。 例如，SVN的修订号和CVS的时间戳。

预定义的 Agent 构建参数

这些 系统属性对于每个构建都是唯一的（例如，包含更改列表的文件路径）。 他们的值是在构建开始之前在代理端计算的，然后传递给构建。

system.teamcity.build.checkoutDir

用于构建的 签出目录。

system.teamcity.build.workingDir

开始构建的 工作目录。 这是 TeamCity 构建运行程序预计启动进程的路径。 这是一个针对运行器的特定属性，因此它在每个步骤中都有一个不同的值。

system.teamcity.build.tempDir

由 TeamCity 生成的构建临时目录的完整路径。 构建后会清理目录。

system.teamcity.build.changedFiles.file

包含构建中更改文件信息的文件的完整路径。 您可以使用此属性在您的自定义测试运行器中 支持风险测试重新排序。

此文件不适用于 历史构建 ，并且如果此特定构建没有任何更改。

system.teamcity.build.properties.file   |   env.TEAMCITY_BUILD_PROPERTIES_FILE

包含所有构建系统属性的文件（包括路径）的全名，但不包括其 system. 后缀。 当构建过程开始时，将会写入此文件，并使用 Java Properties 文件格式 （例如，特殊字符将通过反斜杠进行转义）。

预定义的 Agent 环境参数

这些特定于代理的参数在每个构建代理上定义，并根据其环境变化。 除了标准参数（例如，由运行在代理上的 JVM 提供的 teamcity.agent.jvm.os.name 或 teamcity.agent.jvm.os.arch ），代理可以根据其安装的软件进行参数设置。 TeamCity 会自动检测 .NET Framework、Mono 或 Visual Studio 等软件，并添加相应的 系统属性和 环境变量。

如果代理机器上安装了额外的软件，系统管理员可以修改 <Agent Home>/conf/buildAgent.properties 文件来覆盖相应参数的值。

代理环境参数可以用来设置构建配置选项，定义 代理需求 ，和 在构建脚本内部。

要检查给定构建代理的所有现有参数及其当前值，请打开代理详细信息页面并切换到 参数 选项卡。 请查看此链接以获取更多信息： 检查参数值。

teamcity.agent.name

代理的名称，如在 buildAgent.properties 代理配置文件 中所指定。 您可以使用代理名称来指定 代理要求 ，并限制目标配置可以使用的代理数量。

teamcity.agent.work.dir

代理工作目录 的路径。

teamcity.agent.work.dir.freeSpaceMb

代理工作目录 中可用的空闲空间。

teamcity.agent.home.dir

代理主目录 的路径

teamcity.agent.tools.dir

代理上的 Tools 目录的路径。

teamcity.agent.jvm.os.version

操作系统的版本。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.user.country

用户所在的国家。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.user.home

用户的主目录。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.user.timezone

用户的时区。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.user.name

用户的帐户名称。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.user.language

用户的主要操作系统语言。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.user.variant

用于表示用户区域设置的变化的任意值。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.file.encoding

默认字符集的名称，默认为 UTF-8。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.file.separator

文件分隔符。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.path.separator

路径分隔符。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.specification

Java 运行时环境（JRE）规范版本。 返回 java.specification.version JVM 属性 的值。

teamcity.agent.jvm.version

Java 虚拟机（JVM）实现版本。 报告 对应 JVM 属性的值。

teamcity.agent.jvm.java.home

Java 安装目录。 有关更多信息，请参阅以下部分： Java 相关环境变量。

teamcity.agent.os.arch.bits

代理的操作系统位数。

teamcity.agent.ephemeral

对于启用了“首次构建后”终止条件的云代理，返回 true。 对于可以运行多个构建的代理，不会报告。

DotNetCLI

.NET CLI 版本。

DotNetCLI_Path

.NET CLI可执行文件的路径。

DotNetFramework <版本>[_x86 | _X64]

仅当相应版本的 .NET Framework 运行时已安装，才会定义。

DotNetFramework<version>[_x86|_x64]_Path

此参数的值被设置为相应框架运行时版本的路径。

请注意，此参数仅为每个主要版本的最新安装版本定义。 例如，如果您安装了 3.5 、 4.5 和 4.8 的版本，此参数将仅为 3.5 和 4.8 定义。 版本/参数 4.5 将被省略，因为存在 .NET Framework 4 的较新版本。 要明确定义此类版本，请考虑改用 DotNetFrameworkTargetingPack<version>_Path 参数。

DotNetFrameworkSDK<version>[_x86|_x64]

定义是否已安装对应版本的 .NET Framework SDK 。

DotNetFrameworkSDK<version>[_x86|_x64]_Path

对应框架 SDK 版本的路径。

DotNetFrameworkTargetingPack<version>_Path

对应的参考程序集（又名目标包）位置的路径。

DotNetCoreSDKx.x_Path

.NET SDK 版本。

DotNetWorkloads_<版本>

列出代理机器上安装的所有 .NET 工作负载。

末尾的 <version> 是已安装的 .NET SDK 的版本。 例如，如果安装了版本 7.0.300，代理将报告 `DotNetWorkloads_7.0.300` 参数。

除了这些完整的 SDK 版本，代理还会报告带有缩短的 major.minor 后缀的工作负载参数。 例如，如果代理机器已安装了 7.0.100、7.0.200 和 7.0.300 的 .NET SDK，那么将报告引用最高版本 7.0.300 的 DotNetWorkloads_7.0 参数。

参数值是由逗号分隔的工作负载名称字符串，根据 <dotnet_dir>/metadata/workloads/<sdk_version>/InstalledWorkloads目录中的文件夹。 例如，"android,maui-ios,wasm-tools"。

WindowsSDK<version>

只有在安装了相应的 Windows SDK 版本后才会定义。

WindowsSDK<version>_Path

对应版本的 Windows SDK 的路径。

VS<Version>

定义是否已安装对应的 Visual Studio 版本

VS<Version>_Path

指向 Visual Studio 安装文件夹的路径（包含 devenv.exe 的目录）。

teamcity.dotnet.nunitlauncher<版本>

包含独立 NUnit 测试启动器的目录路径， NUnitLauncher.exe。 版本号是指测试将在其下运行的 .NET Framework 的版本。 版本等同于 .NET Framework 的版本。

teamcity.dotnet.nunitlauncher.msbuild.task

包含 MSBuild 任务 dll 的目录的路径，为 MSBuild 和 Visual Studio (sln) 提供 NUnit 任务。

teamcity.dotnet.msbuild.extensions2.0

包含 MSBuild 2.0 监听器和任务组件的目录的路径。

teamcity.dotnet.msbuild.extensions4.0

包含 MSBuild 4.0 监听器和任务程序集的目录路径。

teamcity.agent.ownPort

TeamCity 服务器用于连接到代理的 代理端口。

teamcity.agent.protocol

代理和服务器之间用于数据传输的 协议。

teamcity.agent.cpuBenchmark

该代理的 CPU 基准测试 结果。

teamcity.agent.hardware.cpuCount

代理机器 CPU 上的核心 / 线程数量。

teamcity.agent.hostname

构建代理主机的名称。

预定义的配置参数

配置参数可以被其他参数引用（仅当在 参数 页面上定义时），但它们不会传递到构建中。

要查看这些服务器参数的完整列表，请打开任何构建的 参数标签页 ，或下载内部 teamcity/properties/build.start.properties.gz 工件。