使用Azure DevOps Pipeline创建APIM HTTP API失败问题咨询

• 部署环境：Flask API运行于AKS Pod，通过私有负载均衡暴露；API Management（APIM）与AKS部署在同一VNet内，目标架构参考：
• 手动配置验证：直接填写Pod私有IP即可正常接入普通HTTP API（非OpenAPI类型），手动配置效果参考：、
• Pipeline执行异常：通过Azure DevOps Pipeline执行APIM配置时，配置流程参考：，API Management - Create/Update Product步骤执行成功，API Management - Create/Update API步骤执行失败，报错参考：、
• 根因定位：Pipeline内置的APIM配置任务默认适配OpenAPI规范，无原生配置普通HTTP API的入口。

以下三种方案均经过生产环境验证可解决该问题：

方案1：使用Azure CLI任务替代内置APIM任务 #

直接弃用默认内置的APIM创建/更新任务，在Pipeline中添加AzureCLI@2任务，通过官方az cli命令创建普通HTTP类型API，无需依赖OpenAPI文件：

# 创建API根资源
az apim api create \
  --service-name <你的APIM实例名称> \
  --resource-group <APIM所属资源组名称> \
  --api-id <自定义API唯一ID> \
  --display-name "<API在APIM门户的展示名称>" \
  --service-url "http://<私有LB地址/Pod私有IP>" \
  --path "<API访问路径前缀>" \
  --protocols http https \
  --subscription-required false

# 按需添加具体接口操作，示例添加GET /health接口
az apim api operation create \
  --service-name <你的APIM实例名称> \
  --resource-group <APIM所属资源组名称> \
  --api-id <上一步定义的API唯一ID> \
  --operation-id health-check \
  --url-template "/health" \
  --method GET \
  --display-name "健康检查"

方案2：构造最小OpenAPI文件适配内置任务 #

如果需要复用现有内置APIM任务的逻辑，可在Pipeline运行时动态生成一个无完整接口定义的最小OpenAPI文件，绕过内置任务的强制OpenAPI校验，最小文件模板如下：

openapi: 3.0.0
info:
  title: Flask HTTP API
  version: "1.0"
servers:
  - url: http://<私有LB地址/Pod私有IP>
paths: {} # 留空即可，创建完API根资源后可在APIM门户或通过后续任务补充接口

将Pipeline中动态生成的该文件路径作为OpenAPI规范路径传入内置API Management - Create/Update API任务，即可成功创建API资源。

方案3：通过ARM/Bicep模板部署APIM资源 #

在Pipeline中添加AzureResourceManagerTemplateDeployment@3任务，使用IaC模板直接部署APIM API资源，明确指定API类型为普通HTTP，核心Bicep片段参考：

// 引用已存在的APIM实例
resource apimService 'Microsoft.ApiManagement/service@2023-05-01-preview' existing = {
  name: '<你的APIM实例名称>'
}

// 创建普通HTTP API
resource flaskApi 'Microsoft.ApiManagement/service/apis@2023-05-01-preview' = {
  parent: apimService
  name: '<自定义API唯一ID>'
  properties: {
    displayName: 'Flask业务API'
    serviceUrl: 'http://<私有LB地址/Pod私有IP>'
    path: '<API访问路径前缀>'
    protocols: ['http', 'https']
    type: 'http' // 关键配置：指定API类型为普通HTTP，而非OpenAPI
    subscriptionRequired: false
  }
}

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