如何在Azure Function中获取UserSecret内存储的连接字符串？

问题根因 #

你自定义构建的IConfiguration已经合并了UserSecrets、appsettings、环境变量的所有配置，但Environment.GetEnvironmentVariable仅能读取进程/系统层面的环境变量，UserSecrets的配置不会自动同步到环境变量中，因此直接读取环境变量无法拿到UserSecrets里存储的连接字符串。

可用方案 #

方案1：直接注入IConfiguration读取配置 #

你已经在Startup中注册了自定义的IConfiguration单例，直接在Function类的构造函数注入即可读取包含UserSecrets在内的全量配置：

public class YourCosmosFunction
{
    private readonly IConfiguration _configuration;

    // 构造函数注入已注册的IConfiguration
    public YourCosmosFunction(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    [FunctionName("YourFunctionName")]
    public async Task<IActionResult> Run(
        [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req,
        ILogger log)
    {
        // 自动按优先级读取UserSecrets/appsettings/环境变量中匹配的配置项
        string cosmosConnStr = _configuration["CosmosConnectionString"];
        CosmosClient cosmos = new CosmosClient(cosmosConnStr, new CosmosClientOptions
        {
            ConnectionMode = ConnectionMode.Gateway
        });
        // 后续业务逻辑
    }
}

方案2（更推荐）：Startup直接注册CosmosClient单例 #

避免每次Function触发都重复初始化CosmosClient，直接在服务注册阶段完成实例初始化，减少不必要的性能开销：

1. 修改Startup的Configure方法，新增CosmosClient注册逻辑：

public override void Configure(IFunctionsHostBuilder builder)
{
    var config = new ConfigurationBuilder()
       .SetBasePath(Environment.CurrentDirectory)
       .AddJsonFile("appsettings.json", true)
       .AddUserSecrets(Assembly.GetExecutingAssembly(), false)
       .AddEnvironmentVariables()
       .Build();
           
    builder.Services.AddSingleton<IConfiguration>(config);

    // 新增：注册CosmosClient单例
    builder.Services.AddSingleton<CosmosClient>(sp => 
    {
        var config = sp.GetRequiredService<IConfiguration>();
        return new CosmosClient(config["CosmosConnectionString"], new CosmosClientOptions
        {
            ConnectionMode = ConnectionMode.Gateway
        });
    });
}

2. Function类中直接注入CosmosClient使用即可：

public class YourCosmosFunction
{
    private readonly CosmosClient _cosmosClient;

    public YourCosmosFunction(CosmosClient cosmosClient)
    {
        _cosmosClient = cosmosClient;
    }

    [FunctionName("YourFunctionName")]
    public async Task<IActionResult> Run(
        [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req,
        ILogger log)
    {
        // 直接使用注入的_cosmosClient操作数据即可
    }
}

注意事项 #

• 本地开发时确认UserSecrets文件中配置的键名与代码中读取的键名完全一致，UserSecrets仅在本地开发环境生效
• 发布到Azure后，直接在Azure Portal的Function应用「配置」-「应用设置」中添加CosmosConnectionString配置项即可，无需修改代码，云端配置优先级高于本地配置文件
• 如果本地运行仍读取不到，可检查项目是否已启用UserSecrets，确认UserSecrets ID与项目配置一致

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