如何在host.json文件中正确引用外部存储的配置值

首先说明两种尝试不生效的核心原因：

1. 环境变量%变量名%占位符仅对Azure Functions官方明确支持的host.json顶层配置字段生效，extensions.http.customHeaders这类嵌套的自定义配置字段不在默认解析范围内，不会被自动替换。另外注意local.settings.json中自定义的变量必须放在Values节点下，才会被识别为函数运行时的环境变量。
2. host.json的默认解析器不支持JSON $ref引用语法，因此第二种写法不会生效。

正确实现方案 #

方案1：构建/启动前预替换（跨语言通用，适用性最广） #

不管使用哪种语言的函数运行时，都可以通过前置脚本在启动前或构建阶段完成host.json的字段替换：

• 本地开发场景：在函数启动命令前添加自定义脚本，读取local.settings.json、package.json等外部文件的目标值，直接写入host.json对应位置
• 云端部署场景：在CI/CD流水线中添加占位符替换步骤，读取构建上下文或云端环境变量的值替换host.json字段

以Node.js语言的项目为例，可参考如下配置：

1. 在package.json中添加启动前置钩子

{
  "scripts": {
    "prestart": "node ./scripts/replace-host-config.js",
    "start": "func start"
  }
}

2. 新增scripts/replace-host-config.js脚本

const fs = require('fs/promises');
const path = require('path');

async function replaceHostConfig() {
  // 读取package.json版本号
  const packageJson = JSON.parse(await fs.readFile(path.join(__dirname, '../package.json'), 'utf-8'));
  // 读取host.json
  const hostJsonPath = path.join(__dirname, '../host.json');
  const hostJson = JSON.parse(await fs.readFile(hostJsonPath, 'utf-8'));
  // 替换自定义头字段
  hostJson.extensions.http.customHeaders['x-version'] = packageJson.version;
  // 回写host.json
  await fs.writeFile(hostJsonPath, JSON.stringify(hostJson, null, 2));
}

replaceHostConfig();

方案2：运行时动态注入（适用于C#等编译型语言） #

如果使用C#类库模式开发Azure Functions，可以在启动类中重写配置加载逻辑，手动处理自定义字段的取值：

[assembly: FunctionsStartup(typeof(YourProjectNamespace.Startup))]
namespace YourProjectNamespace;

public class Startup : FunctionsStartup
{
    public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
    {
        var context = builder.GetContext();
        // 读取host.json
        var hostJsonContent = File.ReadAllText(Path.Combine(context.ApplicationRootPath, "host.json"));
        var hostConfig = JsonSerializer.Deserialize<HostConfig>(hostJsonContent);
        // 读取环境变量替换对应字段
        var version = Environment.GetEnvironmentVariable("SOMEVERSION") ?? "default-version";
        hostConfig.Extensions.Http.CustomHeaders["x-version"] = version;
        // 将处理后的配置注入服务容器即可在后续业务逻辑中使用
    }
}

// 按host.json结构定义对应的实体类即可
public class HostConfig
{
    public string Version { get; set; }
    public ExtensionsConfig Extensions { get; set; }
}

public class ExtensionsConfig
{
    public HttpConfig Http { get; set; }
}

public class HttpConfig
{
    public string RoutePrefix { get; set; }
    public Dictionary<string, string> CustomHeaders { get; set; }
}

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