Azure APIM：通过Bicep部署时如何更新Api的apiRevision并设为当前

需求概述 #

需通过Azure DevOps将API部署到Azure APIM，实现更新apiRevision并设为当前版本，同时明确API更新操作的最佳实践。

问题1：Bicep能否直接读取swagger.json中的版本信息？ #

原生Bicep/ARM模板不支持直接解析外部swagger.json文件提取版本信息，但可通过以下方案实现自动获取：

• Azure DevOps流水线预处理：部署Bicep前，用脚本调用函数App的swagger.json接口，提取info.version字段值并传入模板。示例PowerShell脚本：

  $swaggerUrl = "https://$env:FunctionAppName.azurewebsites.net/api/swagger.json"
  $swaggerContent = Invoke-RestMethod -Uri $swaggerUrl
  $apiVersion = $swaggerContent.info.version
  Write-Host "##vso[task.setvariable variable=apiVersionValue]$apiVersion"
  

• Bicep配合外部数据：可借助自定义脚本扩展实现，但流水线预处理是更简洁高效的方案。

问题2：取消注释isCurrent后报错，如何更新apiRevision并设为当前？ #

报错“Cannot update revision...”的核心原因是：APIM不允许直接修改现有API修订版的isCurrent属性，需通过两步操作实现：

1. 部署新修订版：保留原有Bicep代码（不设置isCurrent），使用新的apiRevisionValue部署新的API修订版，确保name字段的rev=值与新修订版号一致。
2. 切换当前版本：通过以下两种方式将新修订版设为当前：
   • Bicep单独资源操作：添加修订版资源更新isCurrent属性：

     resource apiRevision 'Microsoft.ApiManagement/service/apis/revisions@2022-09-01-preview' = {
       parent: api
       name: apiRevisionValue
       properties: {
         isCurrent: true
       }
     }
     

   • Azure CLI命令：在Bicep部署完成后，执行CLI命令切换：

     az apim api revision update --service-name <APIM实例名> --resource-group <资源组名> --api-id <API名称> --revision <新修订版号> --set isCurrent=true
     

API更新操作最佳实践 #

• 版本与修订版分离：用apiVersion标识业务版本（如v1、v2），apiRevision标识同一版本内的迭代更新（如1、2），避免概念混淆。
• 自动化版本提取：通过流水线脚本自动从swagger.json获取版本，减少手动输入错误，确保APIM版本与后端业务版本一致。
• 先部署再切换当前：先部署新修订版完成验证，再切换为当前版本，降低线上业务影响。
• 保留历史修订版：不要删除旧修订版，便于出现问题时快速回滚。
• 版本集统一管理：通过apiVersionSetId将同一业务版本的不同修订版归组，简化路由与管理。

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