使用Bicep创建的Azure WebApi连接字符串无法正常读取问题

问题背景 #

将.NET7 WebAPI部署至Azure Linux应用服务计划下的应用服务，通过Azure DevOps流水线执行Bicep配置连接字符串后，出现以下读取异常：

• IConfiguration.GetConnectionString("DBConectionString")返回空字符串
• Environment.GetEnvironmentVariable("connectionstrings:DBConectionString")返回空字符串
• 仅Environment.GetEnvironmentVariable("POSTGRESQLCONNSTR_DBConectionString")能正确获取连接字符串
• 尝试将Bicep中连接字符串配置的name改为ConnectionStrings时，发布流水线报错

核心原因 #

1. Azure Linux应用服务的连接字符串环境变量规则：Linux环境下，Azure会将应用服务的连接字符串转换为[TYPE]CONNSTR_[NAME]格式的环境变量（如PostgreSQL对应POSTGRESQLCONNSTR_前缀），而非Windows环境下的ConnectionStrings:[NAME]格式。
2. Bicep配置的限制：Azure应用服务的连接字符串配置资源名称固定为connectionstrings（全小写），无法修改为首字母大写的ConnectionStrings，否则会触发部署报错。
3. .NET配置读取逻辑：IConfiguration.GetConnectionString默认读取ConnectionStrings节点下的配置，或对应ConnectionStrings:[NAME]格式的环境变量，但Linux环境下Azure生成的环境变量格式不匹配这个规则，导致无法读取。

可行解决方案 #

方案1：调整代码读取逻辑适配Azure Linux环境 #

直接读取Azure生成的前缀格式环境变量，或手动将其映射到.NET的ConnectionStrings配置节点：

// 方式1：直接读取前缀格式的环境变量
var dbConnStr = Environment.GetEnvironmentVariable("POSTGRESQLCONNSTR_DBConectionString");
// 方式2：手动映射到ConnectionStrings节点
builder.Configuration["ConnectionStrings:DBConectionString"] = 
    Environment.GetEnvironmentVariable("POSTGRESQLCONNSTR_DBConectionString");

// 后续即可正常使用GetConnectionString
var connStr = builder.Configuration.GetConnectionString("DBConectionString");

方案2：修改Bicep配置，使用应用设置模拟连接字符串 #

在Linux环境下，.NET会将环境变量中的双下划线__解析为配置路径中的冒号:，因此可以通过添加应用设置的方式，让GetConnectionString直接读取：

secure()
param DBConectionString string = ''

resource apiAppSettings 'Microsoft.Web/sites/config@2022-03-01' = {
  name: 'appsettings'
  parent: api
  properties: {
    'ConnectionStrings__DBConectionString': DBConectionString
  }
}

部署后，IConfiguration.GetConnectionString("DBConectionString")即可正常获取连接字符串，无需修改代码。

方案3：保留原Bicep连接字符串配置，添加配置映射 #

如果需要保留原Bicep的连接字符串配置方式，可以在Program.cs中添加环境变量映射规则，让.NET自动识别Azure的前缀格式环境变量：

builder.Configuration.AddEnvironmentVariables();
// 手动将POSTGRESQLCONNSTR_前缀的变量映射到ConnectionStrings节点
var postgresConnVars = Environment.GetEnvironmentVariables()
    .Cast<DictionaryEntry>()
    .Where(entry => entry.Key.ToString().StartsWith("POSTGRESQLCONNSTR_"))
    .ToList();

foreach (var var in postgresConnVars)
{
    var connName = var.Key.ToString().Replace("POSTGRESQLCONNSTR_", "");
    builder.Configuration[$"ConnectionStrings:{connName}"] = var.Value.ToString();
}

临时解决方案说明 #

你当前使用的引用密钥保管库的应用设置方式，本质和方案2类似，都是通过应用设置让.NET读取到正确的配置，属于可行的临时方案，也可以直接切换为方案2的Bicep配置方式简化流程。

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