如何实现Visual Studio与Azure间local.settings.json的自动同步？

我之前也被这个问题折腾过好一阵子！每次改完local.settings.json里的一堆配置，还要手动去Azure门户挨个更新，效率低不说还容易出错。给你分享几个我亲测好用的自动化同步方法，帮你省点时间：

这是我日常用得最多的方法，操作简单还高效：

• 首先确保你已经安装了Azure Functions Core Tools（VS里一般会自带，如果没有的话可以单独安装）。
• 把本地配置推到Azure：打开终端，进入你的函数项目根目录，运行命令：

  func azure functionapp publish <你的函数应用名称> --publish-settings-only
  

  这个命令会把local.settings.json里的Values和ConnectionStrings部分直接同步到Azure的应用设置里，不会重新发布代码，速度很快。
• 把Azure配置拉到本地：如果团队其他人修改了Azure上的配置，你可以用这个命令同步到本地：

  func azure functionapp fetch-app-settings <你的函数应用名称>
  

  注意：这个命令会覆盖你本地的local.settings.json，所以执行前最好备份一下当前文件。

如果你习惯用VS的可视化发布流程，也可以在发布的时候顺便同步配置：

1. 在VS里右键你的函数项目，选择「发布」。
2. 选择你的Azure函数应用作为目标，进入发布设置页面。
3. 找到「应用设置」选项卡，勾选「从local.settings.json导入应用设置」。
4. 你还可以在这里手动调整哪些配置需要同步，比如排除一些只在本地测试用的配置项，确认后再发布，配置就会自动同步到Azure了。

如果是多人协作开发，或者需要把配置和代码一起版本控制，用ARM模板或者Bicep来定义应用设置是个更好的选择：
比如用Bicep写一个简单的配置模板：

resource functionApp 'Microsoft.Web/sites@2022-09-01' = {
  name: 'your-function-app-name'
  location: resourceGroup().location
  properties: {
    siteConfig: {
      appSettings: [
        {
          name: 'ApiKey'
          value: 'your-api-key'
        }
        {
          name: 'DatabaseConnectionString'
          value: 'your-connection-string'
        }
      ]
    }
  }
}

你可以把这个模板和代码一起提交到Git，每次部署的时候用VS的Azure资源组项目或者Azure CLI命令部署，就能自动应用最新的配置，避免手动同步的混乱。

对于一些敏感的配置项（比如密钥、连接字符串），可以不用直接写在local.settings.json里，而是用环境变量来引用：
在local.settings.json里这样写：

{
  "Values": {
    "DatabaseConnection": "%MY_LOCAL_DB_CONN%"
  }
}

然后在本地系统的环境变量里设置MY_LOCAL_DB_CONN的值，Azure那边则直接在应用设置里添加对应的DatabaseConnection配置。这样你不用修改配置文件，只要调整环境变量就行，还能避免敏感信息被提交到代码库。

一些注意事项 #

• 一定要把local.settings.json加入到.gitignore里，避免把本地测试配置或者敏感信息提交到代码仓库。
• 同步配置前最好先备份一下本地或Azure的配置，防止误覆盖重要设置。
• 如果团队规模较大，还可以考虑用Azure App Configuration服务来集中管理所有配置，实现本地和云端的实时同步。

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