Azure Bot Framework Composer CI/CD管道：向appsettings.json注入变量

下面两种方法都是在基于Bot Framework Composer的Azure DevOps部署管道中验证过的可行方案：

方法一：使用Azure DevOps内置的File Transform任务 #

这是最简便的原生方案，适合常规的键值替换场景：

• 先在Azure DevOps管道的「变量」面板中定义好需要注入的变量，比如ApiSettings.ApiKey、ApplicationInsights.ConnectionString，敏感变量记得勾选「保密」选项。
• 在部署阶段添加「File Transform」任务，配置参数：
  • 变换类型选择「JSON」
  • 目标文件设置为**/appsettings.json（根据你的实际文件路径调整，比如部署包中的路径是publish/appsettings.json，就写**/publish/appsettings.json）
  • 变换文件留空即可，任务会自动匹配管道变量名和appsettings.json中的嵌套键名
• 提前在appsettings.json中预留对应键位，示例结构：

  {
    "ApiSettings": {
      "ApiKey": ""
    },
    "ApplicationInsights": {
      "ConnectionString": ""
    }
  }
  

  运行管道时，任务会自动将变量值替换到对应位置。

方法二：使用PowerShell脚本自定义替换 #

适合需要复杂逻辑或特殊格式处理的场景：

• 同样先在Azure DevOps管道中定义好目标变量，敏感变量勾选保密。
• 添加「PowerShell」任务，选择内联脚本，示例代码如下（根据你的JSON结构调整）：

  # 指定appsettings.json的路径，根据实际情况修改
  $settingsPath = "$(System.DefaultWorkingDirectory)/your-project-path/publish/appsettings.json"
  
  # 读取并转换JSON内容
  $settings = Get-Content $settingsPath | ConvertFrom-Json
  
  # 替换目标值
  $settings.ApiSettings.ApiKey = "$(ApiKey)"
  $settings.ApplicationInsights.ConnectionString = "$(AppInsightsConnectionString)"
  
  # 将修改后的内容写回文件，-Depth参数避免嵌套结构丢失
  $settings | ConvertTo-Json -Depth 10 | Set-Content $settingsPath
  

• 确保脚本中的路径和变量名与实际情况完全匹配，运行管道时脚本会完成替换。

注意事项 #

• 敏感变量：Azure DevOps会自动屏蔽保密变量的日志输出，不用担心泄露。
• 路径准确性：务必确认任务中指定的文件路径和部署包中的实际路径一致，否则会找不到文件导致替换失败。
• 变量命名规则：嵌套JSON结构的键名用点分隔，比如Parent.Child.Key对应JSON里的{"Parent": {"Child": {"Key": ""}}}。

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