如何从Azure函数应用运行时修改应用配置值？是否符合最佳实践？

问题描述 #

我目前能在Azure函数应用中读取Azure应用配置的值，但想知道能否在运行时修改这些配置值，以及这种做法是否属于最佳实践。

已完成的Startup类配置：

public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
{
    builder.ConfigurationBuilder.AddAzureAppConfiguration(options =>
    {
        options.Connect(Environment.GetEnvironmentVariable("ConnectionString"))
               .Select("FunctionApp:*")
               .ConfigureRefresh(refreshOptions =>
               {
                   refreshOptions.Register("FunctionApp:Replication:StorageAccount", refreshAll: true);
               });
    });
}
public override void Configure(IFunctionsHostBuilder builder)
{
    builder.Services.AddAzureAppConfiguration();
}

函数应用代码：

public Function2(IConfiguration configuration, IConfigurationRefresherProvider refresherProvider)
{
    _configuration = configuration;
    _configurationRefresher = refresherProvider.Refreshers.First();
}

[FunctionName("Function2")]
public async Task Run([TimerTrigger("*/30 * * * *")] TimerInfo myTimer, ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    await _configurationRefresher.TryRefreshAsync();
    // Read configuration data
    string message = _configuration["FunctionApp:Replication:StorageAccount"];
}

private readonly IConfiguration _configuration;
private readonly IConfigurationRefresher _configurationRefresher;

解答 #

一、运行时修改Azure应用配置值的方法 #

可以通过Azure App Configuration的管理客户端库（Azure.Data.AppConfiguration）在函数运行时修改配置值，具体步骤如下：

1. 安装NuGet包
   在函数项目中安装客户端库：

   Install-Package Azure.Data.AppConfiguration
   

2. 配置客户端实例
   推荐通过依赖注入获取IConfigurationClient，也可直接用连接字符串实例化：

   // 方式1：依赖注入（推荐）
   private readonly IConfigurationClient _configClient;
   
   public Function2(IConfiguration configuration, IConfigurationRefresherProvider refresherProvider, IConfigurationClient configClient)
   {
       _configuration = configuration;
       _configurationRefresher = refresherProvider.Refreshers.First();
       _configClient = configClient;
   }
   
   // 方式2：直接实例化
   // var connectionString = Environment.GetEnvironmentVariable("ConnectionString");
   // var _configClient = new ConfigurationClient(connectionString);
   

3. 执行修改操作
   在函数逻辑中调用SetConfigurationSettingAsync修改目标配置项，修改后建议刷新本地缓存：

   [FunctionName("Function2")]
   public async Task Run([TimerTrigger("*/30 * * * *")] TimerInfo myTimer, ILogger log)
   {
       log.LogInformation("C# HTTP trigger function processed a request.");
   
       // 修改指定键的配置值
       var updatedSetting = new ConfigurationSetting("FunctionApp:Replication:StorageAccount", "new-storage-account-001");
       await _configClient.SetConfigurationSettingAsync(updatedSetting);
   
       // 刷新本地配置缓存，确保后续读取到最新值
       await _configurationRefresher.TryRefreshAsync();
       string updatedValue = _configuration["FunctionApp:Replication:StorageAccount"];
       log.LogInformation("Updated configuration value: {Value}", updatedValue);
   }
   

二、是否属于最佳实践？ #

这种做法需结合场景判断，关键考量点如下：

• 不推荐的场景：

  • 高频写操作：Azure App Configuration并非为频繁更新设计，高频修改可能引发性能问题或额外成本。
  • 存储业务数据：配置项应仅用于存储应用参数，动态业务数据更适合Azure SQL、Cosmos DB等专业存储服务。
  • 权限过度开放：需遵循权限最小化原则，避免函数拥有不必要的配置修改权限，防止误操作或恶意篡改。

• 可接受的场景：

  • 低频率配置调整：例如根据业务状态动态修改阈值、功能开关类配置。
  • 自动化运维场景：由运维自动化工具触发的配置更新，无需人工介入。

总结：运行时修改配置是可行的，但需严格限定使用场景，避免将配置服务当作数据存储使用。

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