如何使用Bicep配置APIM的“All APIs”全局策略？

报错原因 #

全局"All APIs"策略的父资源是APIM服务实例（类型Microsoft.ApiManagement/service），而非单个API（类型Microsoft.ApiManagement/service/apis）。之前的配置错误地将父资源指向了单个API层级，导致类型不匹配报错。

正确Bicep配置示例 #

1. 定义APIM实例（可复用现有已定义的实例） #

resource apimService 'Microsoft.ApiManagement/service@2022-08-01' = {
  name: 'your-apim-resource-name'
  location: 'eastus'
  properties: {
    publisherName: 'Your Org Name'
    publisherEmail: 'admin@your-org.com'
    sku: {
      name: 'Consumption'
      capacity: 0
    }
  }
}

2. 配置全局"All APIs"策略 #

全局策略的资源类型为Microsoft.ApiManagement/service/policies，直接关联APIM实例作为父资源，策略类型固定为allApis：

resource apimGlobalAllApisPolicy 'Microsoft.ApiManagement/service/policies@2022-08-01' = {
  parent: apimService
  name: 'policy'
  properties: {
    value: '<policies><inbound><rate-limit-by-key calls="100" renewal-period="60" counter-key="@(context.Request.IpAddress)" /></inbound><backend><base /></backend><outbound><base /></outbound><on-error><base /></on-error></policies>'
    format: 'xml'
  }
}

关键注意事项 #

• 全局策略的资源名称必须固定为policy，不支持自定义名称
• 策略内容需遵循APIM官方XML格式规范，可根据业务需求添加限流、日志、请求转换等具体规则
• 建议使用较新的API Management API版本（示例为2022-08-01），避免版本兼容问题

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