Azure Functions v4本地运行无法读取用户机密至local.settings.json

问题背景 #

在.NET 6版本的Azure Functions v4中，本地通过Visual Studio运行时，无法通过Environment.GetEnvironmentVariable读取User Secrets中的值，但将机密添加到local.settings.json的Values节点时可正常获取。推测User Secrets未被正确加载为配置源。

核心原因 #

Azure Functions本地运行时默认仅从local.settings.json的Values节点和系统环境变量加载配置，不会自动包含User Secrets；同时静态函数默认无法直接获取包含User Secrets的配置实例，需手动配置加载逻辑。

解决方案 #

1. 对齐NuGet包版本 #

将Microsoft.Extensions.Configuration.UserSecrets包升级至与.NET 6匹配的6.0.x版本（当前使用的5.0.0存在版本兼容性问题）。

2. 方案一：改用实例函数+依赖注入（推荐） #

通过依赖注入获取包含User Secrets的IConfiguration实例，这是Azure Functions v4的标准做法：

修改Function1.cs

public class Function1
{
    private readonly IConfiguration _configuration;

    // 构造函数注入IConfiguration
    public Function1(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    [FunctionName("Function1")]
    public async Task<IActionResult> Run(
        [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req,
        ILogger log)
    {
        // 读取User Secrets中的值，对应secrets.json里的键名
        var secret = _configuration["mysecret"];
        // 若使用"Values:mysecret"键名，则改为 _configuration["Values:mysecret"]
        return new OkObjectResult($"Secret is: {secret}");
    }
}

添加Startup配置类

创建Startup.cs，自定义配置加载逻辑，确保User Secrets被包含：

using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System.IO;

[assembly: FunctionsStartup(typeof(FunctionApp1.Startup))]
namespace FunctionApp1
{
    public class Startup : FunctionsStartup
    {
        public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
        {
            var context = builder.GetContext();
            
            builder.ConfigurationBuilder
                // 加载当前项目的User Secrets
                .AddUserSecrets<Startup>(optional: false)
                // 加载local.settings.json
                .AddJsonFile(Path.Combine(context.ApplicationRootPath, "local.settings.json"), optional: true, reloadOnChange: true)
                // 加载系统环境变量
                .AddEnvironmentVariables();
        }

        public override void Configure(IFunctionsHostBuilder builder)
        {
            // 可在此注册其他依赖服务
        }
    }
}

3. 方案二：静态函数手动构建配置 #

若需保留静态函数，可手动构建包含User Secrets的配置实例：

public static class Function1
{
    // 提前构建配置实例，确保只初始化一次
    private static readonly IConfiguration _configuration = new ConfigurationBuilder()
        .AddUserSecrets<Function1>()
        .AddJsonFile("local.settings.json", optional: true)
        .AddEnvironmentVariables()
        .Build();

    [FunctionName("Function1")]
    public static async Task<IActionResult> Run(
        [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req,
        ILogger log)
    {
        var secret = _configuration["mysecret"];
        return new OkObjectResult($"Secret is: {secret}");
    }
}

4. 验证User Secrets配置 #

右键项目 → 管理用户机密，确认secrets.json内容正确，例如：

{
  "mysecret": "test1"
}

同时确保项目文件FunctionApp1.csproj中的UserSecretsId与本地机密文件夹的ID一致：

<UserSecretsId>24c7ab90-4094-49a9-94ef-c511ac530526</UserSecretsId>

内容的提问来源于stack exchange，提问作者chrisbuttacavoli