如何在通用Bicep模板中为Azure App Service添加连接字符串

核心思路 #

不用修改appservices.bicep子模块，通过在顶层模板appservicetemplate.bicep中新增连接字符串配置资源，借助App Service子模块的输出引用父资源，同时暴露参数让主模块灵活传入配置，既保持子模块通用性，又实现连接字符串的自定义配置。

具体步骤 #

1. 在模板仓库的appservicetemplate.bicep中添加连接字符串参数

添加可选参数，默认空数组，不传入时不会创建连接字符串配置：

// Template Repo - appservicetemplate.bicep
param aspName string
param aiName string
param asName string
param appSettings array = []
// 新增连接字符串参数，支持自定义类型
param connectionStrings array = [
  {
    name: string
    value: string
    type: string // 可选值：SQLAzure, MySQL, SQLServer, Custom等
  }
]

// 原有的模块调用保持不变
module appserviceplanModule 'appserviceplan.bicep' = {
  name: hostingModule
  params: {
    // 原参数
  }
}

module appInsightModule 'appinsights.bicep' = {
  name: aiModule
  params: {
    // 原参数
  }
}

module appServiceModule 'appservices.bicep' = {
  name: asModule
  params: {
    aspName: aspName
    asName: asName
    appSettings: appSettings
    // 其他原参数
  }
  dependsOn: [appserviceplanModule, appInsightModule]
}

2. 确保appservices.bicep输出App Service名称

在appservices.bicep中添加输出，让顶层模板能引用到App Service的名称：

// Template Repo - appservices.bicep
param asName string
param aspName string
param appSettings array = []

resource appService 'Microsoft.Web/sites@2022-03-01' = {
  name: asName
  location: resourceGroup().location
  properties: {
    serverFarmId: resourceId('Microsoft.Web/serverfarms', aspName)
    siteConfig: {
      appSettings: appSettings
    }
  }
}

// 新增输出
output appServiceName string = asName

3. 在appservicetemplate.bicep中添加连接字符串配置资源

利用App Service模块的输出作为父资源名称，仅当传入连接字符串时才创建该资源：

// Template Repo - appservicetemplate.bicep
// ... 前面的参数和模块调用 ...

// 新增连接字符串配置资源
resource appServiceConnectionStrings 'Microsoft.Web/sites/config@2022-03-01' = if (!empty(connectionStrings)) {
  name: '${appServiceModule.outputs.appServiceName}/connectionstrings'
  properties: {
    connectionStrings: [for cs in connectionStrings: {
      name: cs.name
      connectionString: cs.value
      type: cs.type
    }]
  }
  dependsOn: [appServiceModule]
}

4. 在主仓库的main.bicep中传入连接字符串参数

调用模板模块时，按需传入连接字符串：

// main bicep of repository 1
module appServiceTemplateModule '../appservicetemplate.bicep' = {
  name: 'appServiceTemplateDeploy'
  params: {    
    aspName: 'aspName'
    aiName: 'aiName'
    asName: 'asName'
    appSettings: [      
      {
        name: 'APP_SETTING_1'
        value: 'value1'
      }
      {
        name: 'APP_SETTING_2'
        value: 'value2'
      }
      {
        name: 'ApplicationInsightsAgent_EXTENSION_VERSION'
        value: '~2'
      }
    ]
    // 传入连接字符串
    connectionStrings: [
      {
        name: 'MyDatabase'
        value: 'Server=tcp:mydb.database.windows.net,1433;Initial Catalog=MyDb;Persist Security Info=False;User ID=admin;Password=xxxx;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;'
        type: 'SQLAzure'
      }
      {
        name: 'RedisCache'
        value: 'mycache.redis.cache.windows.net:6380,password=xxxx,ssl=True,abortConnect=False'
        type: 'Custom'
      }
    ]
  }
}

方案优势 #

• 保持appservices.bicep的通用性，仅负责App Service核心配置，无需为连接字符串修改子模块
• 连接字符串作为可选配置，主模块可根据需要传入或省略，不影响基础部署
• 完全遵循Bicep模块化设计，依赖关系清晰，资源创建顺序自动处理

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