如何通过Bicep为APIM的所有API配置诊断设置

你要配置的「所有API」诊断设置，本质是APIM服务级别的全局诊断配置，而非单个API的独立诊断。对应的Bicep资源直接挂载在APIM服务实例下，而非某个具体API资源下。

实现代码 #

假设你已定义好APIM服务资源apiManagementServiceName_resource，以及对应的App Insights logger ID（loggerid），添加以下服务级诊断资源即可：

// 保留你已有的单个API定义（按需保留）
resource apiManagementServiceName_api_name 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
  parent: apiManagementServiceName_resource
  name: api_name
  properties: {
    displayName: api_name
    apiRevision: '1'
    subscriptionRequired: true
    path: api_name
    protocols: [
      'https'
    ] 
  }
}

// 服务级全局诊断（对应UI中的「所有API」诊断设置）
resource apiManagementGlobalDiagnostics 'Microsoft.ApiManagement/service/diagnostics@2021-08-01' = {
  parent: apiManagementServiceName_resource
  name: 'appInsights'
  properties: {
    loggerId: loggerid
    alwaysLog: 'allErrors'
    verbosity: 'error'
    enabled: true
    // 可选：自定义前后端请求/响应的日志记录规则
    frontend: {
      request: {
        headers: []
        body: { bytes: 0 }
      }
      response: {
        headers: []
        body: { bytes: 0 }
      }
    }
    backend: {
      request: {
        headers: []
        body: { bytes: 0 }
      }
      response: {
        headers: []
        body: { bytes: 0 }
      }
    }
  }
}

关键说明 #

• 资源类型区别：单个API诊断用Microsoft.ApiManagement/service/apis/diagnostics，全局诊断用Microsoft.ApiManagement/service/diagnostics，父资源从单个API改为APIM服务实例，从而覆盖所有API。
• 全局诊断优先级：如果部分API已配置独立诊断，全局诊断默认不会覆盖这些API的设置，若需统一覆盖，可调整诊断规则的优先级或修改单个API的诊断配置。
• loggerId需确保指向你已创建的App Insights logger资源ID，格式通常为${apiManagementServiceName_resource.id}/loggers/[你的logger名称]。

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