Azure Pipeline使用originalSwaggerUrl部署自定义连接器时API定义未更新

你遇到的问题是ARM模板部署自定义连接器成功，但API定义未更新，以下是具体原因和解决办法：

1. originalSwaggerUrl字段的正确性 #

originalSwaggerUrl是Microsoft.Web/customApis资源中指定Swagger URL的正确字段，但存在缓存或部署逻辑导致的更新不生效问题。

2. 缓存导致的旧Swagger复用 #

Azure自定义连接器会缓存Swagger内容，即使你的API端的Swagger已经更新，部署时可能仍拉取缓存版本。解决方式：

• 给Swagger URL添加缓存破折参数，比如将http://someapi/v1/swagger/docs/v1改为http://someapi/v1/swagger/docs/v1?cb=[当前时间戳或版本号]，每次更新时修改这个参数值，强制Azure拉取最新内容。
• 先手动访问Swagger URL，确认返回的是最新的API定义内容，同时确保Azure环境能正常访问该URL（无防火墙、权限限制）。

3. ARM增量部署的更新触发逻辑 #

当自定义连接器已存在时，ARM增量部署仅在检测到资源属性变更时才会执行更新操作。如果originalSwaggerUrl值未变，ARM会认为无需更新，自然不会重新拉取Swagger。解决方式：

• 在模板中添加一个动态变化的属性，强制触发更新。比如在资源的properties里添加标签：

  "properties": {
      ...
      "apiType": "rest",
      "apiDefinitions": {
          "originalSwaggerUrl": "[parameters('swaggerSpec')]"
      },
      "tags": {
          "lastDeploymentTime": "[utcNow()]"
      }
      ...
  }
  

  每次部署时utcNow()会生成新的时间戳，ARM会检测到标签变更，触发资源更新流程，进而重新拉取Swagger。

4. 尝试更新API版本 #

当前模板使用的apiVersion是2016-06-01，可尝试替换为较新的版本（如2021-03-01），新版本的资源定义可能优化了Swagger更新的逻辑：

"type": "Microsoft.Web/customApis",
"apiVersion": "2021-03-01",
...

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