如何创建可从parameters.json接收可变数量AppSettings且不覆盖默认配置的Web应用ARM模板
适用ARM模板的可变数量AppSettings配置方案
本方案同时解决全量覆盖默认配置、拼接JSON可读性差、换行校验报错三个核心问题,支持直接从parameters.json传入任意数量自定义配置。
步骤1:定义参数实现可变数量传入
在模板的parameters块中定义object类型的自定义AppSettings参数,用户无需修改模板结构,即可在参数文件中增删任意键值对:
"parameters": { "webAppName": { "type": "string", "defaultValue": "my-demo-webapp", "metadata": { "description": "目标Web应用的名称" } }, "appSettings": { "type": "object", "defaultValue": {}, "metadata": { "description": "用户自定义AppSettings,可传入任意数量键值对" } } }
对应的parameters.json可直接按需求添加配置,示例:
{ "contentVersion": "1.0.0.0", "parameters": { "appSettings": { "value": { "CustomKey1": "CustomValue1", "CustomKey2": "CustomValue2", "ThirdCustomKey": "ThirdValue" } } } }
步骤2:合并配置避免覆盖默认值
全程使用ARM原生对象语法,无需拼接JSON字符串,模板可随意换行排版,通过reference拉取现有平台默认配置,再按优先级合并自定义内容。
首先在variables块中定义固定需要的基础配置:
"variables": { "webAppName": "[parameters('webAppName')]", "appInsightsName": "[concat(variables('webAppName'), '-insights')]", // 原生对象语法,可随意换行排版 "fixedRequiredAppSettings": { "APPINSIGHTS_INSTRUMENTATIONKEY": "[reference(concat('microsoft.insights/components/', variables('appInsightsName')), '2015-05-01').InstrumentationKey]", "ApplicationInsightsAgent_EXTENSION_VERSION": "~3" } }
然后定义Microsoft.Web/sites/config资源,通过union函数按优先级合并配置:
{ "type": "Microsoft.Web/sites/config", "apiVersion": "2022-03-01", "name": "[concat(variables('webAppName'), '/appsettings')]", "dependsOn": [ "[resourceId('Microsoft.Web/sites/', variables('webAppName'))]", "[resourceId('microsoft.insights/components/', variables('appInsightsName'))]" ], "properties": "[ union( // 1. 先拉取Web应用已有的所有平台默认配置 reference(resourceId('Microsoft.Web/sites/config', variables('webAppName'), 'appsettings'), '2022-03-01').properties, // 2. 叠加固定需要的基础配置 variables('fixedRequiredAppSettings'), // 3. 合并用户传入的自定义配置,优先级最高 parameters('appSettings') ) ]" }
关键说明
- 校验兼容性:全程未使用
json(concat(...))拼接字符串,所有操作作用于ARM原生对象,模板可随意换行排版,az deployment group validate可正常通过。 - 配置优先级:用户自定义AppSettings > 固定基础配置 > 平台默认配置,如需调整优先级,只要修改
union函数的参数顺序即可。 - 防覆盖逻辑:通过
reference拉取现有Web应用的全量配置,再合并自定义内容,不会清空平台默认的Application Insights等内置配置。 - 可变参数支持:用户仅需在parameters.json的
appSettings对象下增删键值对,即可实现任意数量的自定义配置,无需修改模板主体结构。
内容的提问来源于stack exchange,提问作者Oliver Nilsen
相关产品推荐
相关产品推荐

