UseDotNet@2 - 使用 dotnet v2 任务

使用该任务从internet或本地缓存获取特定版本的.NET Core SDK,并将其添加到PATH。 使用此任务更改后续任务中使用的 .NET Core 版本。 此任务还提供代理支持。

语法

# Use .NET Core v2
# Acquires a specific version of the .NET Core SDK from the internet or the local cache and adds it to the PATH. Use this task to change the version of .NET Core used in subsequent tasks. Additionally provides proxy support.
- task: UseDotNet@2
  inputs:
    #packageType: 'sdk' # 'runtime' | 'sdk'. Package to install. Default: sdk.
    #useGlobalJson: false # boolean. Optional. Use when packageType = sdk. Use global json. Default: false.
    #workingDirectory: # string. Optional. Use when useGlobalJson = true. Working Directory. 
    #version: # string. Optional. Use when useGlobalJson = false || packageType = runtime. Version. 
    #includePreviewVersions: false # boolean. Optional. Use when useGlobalJson = false  || packageType = runtime. Include Preview Versions. Default: false.
    #requestTimeout: '300000' # string. Set timeout for package download request. Default: 300000.
  # Advanced
    #vsVersion: # string. Compatible Visual Studio version. 
    #checkForExistingVersion: false # boolean. Check for existing installation. Default: false.
    #installationPath: '$(Agent.ToolsDirectory)/dotnet' # string. Path To Install .Net Core. Default: $(Agent.ToolsDirectory)/dotnet.
    #performMultiLevelLookup: false # boolean. Perform Multi Level Lookup. Default: false.
# Use .NET Core v2
# Acquires a specific version of the .NET Core SDK from the internet or the local cache and adds it to the PATH. Use this task to change the version of .NET Core used in subsequent tasks. Additionally provides proxy support.
- task: UseDotNet@2
  inputs:
    #packageType: 'sdk' # 'runtime' | 'sdk'. Package to install. Default: sdk.
    #useGlobalJson: false # boolean. Optional. Use when packageType = sdk. Use global json. Default: false.
    #workingDirectory: # string. Optional. Use when useGlobalJson = true. Working Directory. 
    #version: # string. Optional. Use when useGlobalJson = false || packageType = runtime. Version. 
    #includePreviewVersions: false # boolean. Optional. Use when useGlobalJson = false  || packageType = runtime. Include Preview Versions. Default: false.
    #requestTimeout: '300000' # string. Set timeout for package download request. Default: 300000.
  # Advanced
    #vsVersion: # string. Compatible Visual Studio version. 
    #installationPath: '$(Agent.ToolsDirectory)/dotnet' # string. Path To Install .Net Core. Default: $(Agent.ToolsDirectory)/dotnet.
    #performMultiLevelLookup: false # boolean. Perform Multi Level Lookup. Default: false.
# Use .NET Core v2
# Acquires a specific version of the .NET Core SDK from the internet or the local cache and adds it to the PATH. Use this task to change the version of .NET Core used in subsequent tasks. Additionally provides proxy support.
- task: UseDotNet@2
  inputs:
    #packageType: 'sdk' # 'runtime' | 'sdk'. Package to install. Default: sdk.
    #useGlobalJson: false # boolean. Optional. Use when packageType = sdk. Use global json. Default: false.
    #workingDirectory: # string. Optional. Use when useGlobalJson = true. Working Directory. 
    #version: # string. Optional. Use when useGlobalJson = false || packageType = runtime. Version. 
    #includePreviewVersions: false # boolean. Optional. Use when useGlobalJson = false  || packageType = runtime. Include Preview Versions. Default: false.
  # Advanced
    #vsVersion: # string. Compatible Visual Studio version. 
    #installationPath: '$(Agent.ToolsDirectory)/dotnet' # string. Path To Install .Net Core. Default: $(Agent.ToolsDirectory)/dotnet.
    #performMultiLevelLookup: false # boolean. Perform Multi Level Lookup. Default: false.

输入

packageType - 安装包
string。 允许的值: runtime, ( sdk SDK(包含运行时))。 默认值:sdk。

指定是只安装 .NET 运行时还是 SDK。


useGlobalJson - 使用全局json
boolean。 自选。 当 packageType = sdk时使用。 默认值:false。

从文件安装所有 SDK global.json 。 这些文件是从 system.DefaultWorkingDirectory。 可以通过设置工作目录输入来更改搜索根路径。

任务还会sdk.rollForwardglobal.json读取并安装满足指定滚动前进策略的最新版本。 例如,如果你 global.json 指定 "version": "8.0.302" 了 "rollForward": "latestFeature",任务安装的是最新的 8.0.x SDK,而不是精确版本。 如果sdk.rollForward不存在,任务将安装与之前行为一致的精确版本。sdk.version 有关支持 rollForward 值的更多信息,请参见 备注 部分和 global.json 概述。

6.x输入中UseDotNet@2.version描述的 和 6.1.x 格式(用作.x通配符)用于version任务中的输入,而非sdk.versionglobal.json参数。

如果你收到类似 ##[error]Version 6.0.x is not allowed. Allowed version types are: majorVersion.x, majorVersion.minorVersion.x, majorVersion.minorVersion.patchVersion. More details: Only explicit versions and accepted, such as: 2.2.301. Version: 6.0.x is not valid. 的错误提示,并且你正在使用 global.json,请在 sdk.version 你的 global.json.

有关global.json的更多信息,请参见选择使用.NET版本。


workingDirectory - 工作目录
string。 自选。 当 useGlobalJson = true时使用。

指定使用useGlobalJson时文件应从哪里global.json搜索的路径。 如果值为空,则 system.DefaultWorkingDirectory 视为根路径。


version - 版本
string。 自选。 当 useGlobalJson = false || packageType = runtime时使用。

指定安装的 .NET Core SDK 版本或运行时。 版本值格式以示例显示:

  • 2.x安装最新的SDK或运行时,指定的主要版本。 2
  • 3.1.x安装最新的SDK或运行时,包含指定的主要和次要版本, 3 且 1。
  • 3.1.402安装指定的SDK或运行时版本。 3.1.402

SDK 或运行时安装的版本值都在文件中 releases.json 。 主 releases.json /次要版本的链接在 releases-index 文件中。 例如, 3.1版本的releases.json 文件链接。


vsVersion - 兼容Visual Studio版本
string。

指定了对应的 .NET Core SDK 安装的兼容 Visual Studio 版本。 该值必须是一个完整的版本号,例如 16.6.4,包含一个主要版本、一个次要版本和一个补丁号。

用于字符串的SDK或运行时安装 version 版本值已在文件中 releases.json 。 主 releases.json /次要版本的链接在 releases-index 文件中。 例如, 3.1版本的releases.json 文件链接。


checkForExistingVersion - 检查现有安装情况
boolean。 默认值:false。

如果你想检测指定版本是否已经安装,可以选择在下载前选择。 仅在 installationPath 为空,即设为默认值时使用。


includePreviewVersions - 包含预览版本
boolean。 自选。 当 useGlobalJson = false || packageType = runtime时使用。 默认值:false。

如果设置为 true,任务搜索最新的运行时/SDK 版本时会包含预览版本,例如搜索 2.2.x 或 3.1.x。 如果你指定一个精确版本,例如 3.0.100-preview3-010431,该设置将被忽略。


installationPath - 安装 .Net Core 的路径
string。 默认值:$(Agent.ToolsDirectory)/dotnet。

指定 .NET Core SDK / 运行时应安装在哪里。 不同的路径可能会对 .NET 的行为产生以下影响。

  • $(Agent.ToolsDirectory): 使用此路径会缓存安装在代理上,因为该目录不会在管道间进行清理。 代理上运行的所有管道都有权访问以前安装的版本。
  • $(Agent.TempDirectory):使用此路径确保管道不会使用缓存版本的.NET Core,因为该文件夹在每次管道后都会被清理。
  • 另一种路径:只要代理进程有权限访问该路径,你就可以使用任何路径。 这将更改计算机的状态,并影响其上运行的所有进程。

注意

您可以使用多层查找设置,performMultiLevelLookup,来配置.NET主机如何搜索版本。


performMultiLevelLookup - 执行多层查找
boolean。 默认值:false。

配置 .NET 主机进程在寻找合适共享框架时的行为。 值为:

  • false:主机进程只搜索任务指定的文件夹中存在的版本。
  • true:主机进程将通过多级查找在预定义的全局位置进行搜索。 默认全局位置为:
    • C:\Program Files\dotnet (64位进程)
    • C:\Program Files (x86)\dotnet (32位进程)

了解更多关于 多级 SharedFX 查找的信息。

注意

performMultiLevelLookup仅适用于基于Windows的代理人。


requestTimeout - 设置包下载请求的超时
string。 默认值:300000。

为任务为获取 .NET 包所做的 HTTP 请求提供超时值。 该值以毫秒为单位。 默认值为 300000 毫秒(5 分钟)。 不能超过 600000 毫秒(10 分钟)。


任务控制选项

除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性。

输出变量

没有。

言论

使用.NET核心任务从inte rnet或工具缓存中获取特定版本的.NET Core并将其添加到Azure Pipelines代理(托管或私有)的PATH中。 使用此任务更改后续任务中使用的.NET核心版本,如DotNetCoreCLI@2。 在构建定义的 DotNetCoreCLI@2 之前添加此任务,可以确保该版本在构建、测试和发布应用时依然可用。

工具安装程序方法还允许从代理更新周期中分离。 如果你想要的 .NET Core 版本在 Azure Pipelines 代理(托管或私有)中缺少,那么你可以用这个任务在代理上安装正确的版本。

global.json 的滚动支持。

当 useGlobalJson 设置为 true时,任务会读取你的global.json文件中的sdk.rollForward属性,并安装满足指定滚动策略的最新 SDK 版本。 对于 disable、 patch、 feature和 minor 策略,这与 .NET CLI 在本地解析 SDK 版本的方式相符;major并且latestMajor目前在同一主版本内解析。

如果 sdk.rollForward 不存在 global.json于 ,任务将安装 中 sdk.version指定的版本。 这和之前的行为相符。

下表展示了每个 rollForward 值如何影响版本分辨率:

rollForward 值 Behavior 示例:版本 8.0.302 解析为
disable 安装了指定的精确版本。 8.0.302
patch 在同一功能区间内安装最新的补丁。 最新消息 >=8.0.300 <8.0.400
latestPatch 与 patch 相同。 最新消息 >=8.0.300 <8.0.400
feature 在同一 major.minor 版本中安装最新的功能频段。 最新消息 8.0.x
latestFeature 与 feature 相同。 最新消息 8.0.x
minor 在同一主版本中安装最新的次要版本。 最新消息 8.x
latestMinor 与 minor 相同。 最新消息 8.x
major 在同一主版本中安装最新版本。 最新消息 8.x
latestMajor 与 major 相同。 最新消息 8.x

注意

UseDotNet@2中, major 和 latestMajor 策略目前仅在同一主要版本中解析。 跨主打版本解析尚未支持。

如果 global.json 包含未识别 rollForward 的值,任务会记录警告并回退到安装中 sdk.version指定的精确版本。

关于完整的数值规范 rollForward ,请参见 global.json 概述。

示例

使用 global.json 安装最新的功能带

以下 global.json 文件指定了 SDK 版本 8.0.302 ,设置为 rollForwardlatestFeature。 该任务安装最新的 8.0.x SDK。

{
  "sdk": {
    "version": "8.0.302",
    "rollForward": "latestFeature"
  }
}
steps:
- task: UseDotNet@2
  displayName: 'Install .NET SDK from global.json'
  inputs:
    packageType: 'sdk'
    useGlobalJson: true

在功能区间内安装最新补丁,使用 global.json

以下 global.json 文件指定了 SDK 版本 8.0.302 ,设置为 rollForwardlatestPatch。 该任务是在功能范围内安装最新的 SDK 版本 8.0.3xx 。

{
  "sdk": {
    "version": "8.0.302",
    "rollForward": "latestPatch"
  }
}
steps:
- task: UseDotNet@2
  displayName: 'Install .NET SDK from global.json'
  inputs:
    packageType: 'sdk'
    useGlobalJson: true

要求

要求 描述
管道类型 YAML,经典版本,经典版本
运行时间 代理,DeploymentGroup
需求 没有
功能 运行该任务满足同一作业中后续任务的 以下要求 :DotNetCore
命令限制 任何
Settable 变量 任何
代理版本 2.144.0 或更高版本
任务类别 工具

另请参阅