Azure Bicep应用网关子资源正确引用及警告消除方法问询

问题场景 #

使用Azure Bicep部署应用网关时，手动拼接后端地址池的资源ID会触发Linter警告：

Warning use-resource-id-functions: If property "id" represents a resource ID, it must use a symbolic resource reference, be a parameter or start with one of these functions: extensionResourceId, guid, if, reference, resourceId, subscription, subscriptionResourceId, tenantResourceId.

用户的原始代码片段：

var applicationGatewayId = resourceId('Microsoft.Network/applicationGateways', applicationGatewayName)
resource applicationGateway 'Microsoft.Network/applicationGateways@2021-08-01' = {
  properties: {
    urlPathMaps: [
      {
        properties: {
          defaultBackendAddressPool: {
            id: '${applicationGatewayId}/backendAddressPools/backendpool-test'
          }
      }
    ]
  }
}

尝试过的方法均存在问题：

• 使用${applicationGateway.id}/backendAddressPools/backendpool-test触发循环引用错误；
• 使用resourceId('Microsoft.Network/ApplicationGatewayBackendAddressPool', '${prefix}-backendpool-infocat')生成的ID格式错误，因为子资源类型参数不正确。

该问题适用于应用网关的多类嵌套子资源引用场景，例如：

• applicationGateway.urlPathMaps.defaultBackendAddressPool
• applicationGateway.urlPathMaps.pathRules.backendAddressPool
• applicationGateway.urlPathMaps.pathRules.backendHttpSettings
• 其他应用网关子资源

解决方案 #

针对这类父资源下的嵌套子资源，有两种正确的引用方式可以消除警告：

1. 符号化引用同资源内的子资源（推荐） #

如果后端地址池是在当前应用网关资源中定义的，直接通过符号化引用子资源的ID，无需手动拼接：

resource applicationGateway 'Microsoft.Network/applicationGateways@2021-08-01' = {
  name: applicationGatewayName
  properties: {
    // 先定义后端地址池子资源
    backendAddressPools: [
      {
        name: 'backendpool-test'
        properties: {
          // 配置后端地址池的具体内容，例如IP地址或FQDN
          backendAddresses: [
            {
              ipAddress: '10.0.0.4'
            }
          ]
        }
      }
    ]
    urlPathMaps: [
      {
        name: 'test-url-path-map'
        properties: {
          defaultBackendAddressPool: {
            // 直接引用同资源内的后端地址池ID
            id: applicationGateway.properties.backendAddressPools[0].id
          }
        }
      }
    ]
  }
}

如果子资源数量较多，可以用filter函数精准匹配名称：

id: first(filter(applicationGateway.properties.backendAddressPools, pool => pool.name == 'backendpool-test')).id

2. 使用resourceId函数的完整层级格式 #

应用网关的子资源需要使用父资源类型/子资源类型的组合作为resourceId的第一个参数，而非单独的子资源类型，这样能生成正确的资源ID：

resource applicationGateway 'Microsoft.Network/applicationGateways@2021-08-01' = {
  properties: {
    urlPathMaps: [
      {
        properties: {
          defaultBackendAddressPool: {
            // 正确格式：父资源类型/子资源类型，父资源名称，子资源名称
            id: resourceId('Microsoft.Network/applicationGateways/backendAddressPools', applicationGatewayName, 'backendpool-test')
          }
      }
    ]
  }
}

同理，其他子资源也可以用这种格式，比如后端HTTP设置：

id: resourceId('Microsoft.Network/applicationGateways/backendHttpSettingsCollection', applicationGatewayName, 'backendHttpSettings-test')

3. 解决循环引用问题 #

如果出现循环引用，通常是因为子资源与父资源存在双向依赖。此时可以将子资源的定义与引用逻辑拆分，或者通过dependsOn显式声明依赖关系（Bicep多数场景会自动处理依赖，复杂嵌套时可手动补充）。

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