使用ARM模板部署Azure API Management时如何禁用软删除功能

基础事实澄清 #

• 自2021年春季版起，Azure API Management（APIM）实例的软删除功能对所有资源默认强制开启，软删除资源默认留存48小时后才会自动清除，该功能的配置逻辑与Key Vault存在本质差异。
• 目前APIM的ARM资源定义（Microsoft.ApiManagement/service类型）中未开放软删除开关的可配置入参：参照Key Vault的配置方式在APIM资源块内添加enableSoftDelete: false字段，会被ARM模板校验直接识别为未知属性，既无法通过校验，也起不到关闭软删除、规避同名部署冲突的作用。
• 所有和APIM软删除相关的可操作能力，均仅在软删除资源的查询、恢复、永久清除类接口中提供，创建/部署APIM的全流程（含ARM模板部署）没有开放软删除参数的配置入口。

适配固定CI管道流程的实操方案 #

针对管道“拆除资源组后次日重部署、无法调整等待周期适配48小时软删除留存窗口”的固定规则，可通过插入轻量化前置步骤完全解决同名部署冲突：

• 调整原管道流程顺序：在资源组清理完成、执行ARM模板部署APIM资源的节点之前，增加一个软删除资源清理步骤：
  • 先查询当前订阅下、与待部署APIM同区域、同名称的软删除APIM记录，获取对应记录的资源ID
  • 调用永久清除接口直接删除该软删除记录，整个操作耗时不足10秒，完全不会拉长管道的整体执行时长
• 无需修改原有ARM模板的资源配置逻辑，当前APIM的资源定义中没有可用于跳过软删除冲突的内置参数，强行添加自定义软删除字段反而会触发模板校验失败。

常见踩坑提醒 #

• 不要尝试通过调整资源组删除方式规避软删除：只要是在软删除功能默认启用后创建的APIM实例，无论通过什么方式触发删除，都会自动进入软删除列表，不会直接被永久清除。
• 不要寄希望于软删除资源的自动过期机制匹配管道周期，除了提前永久清除软删除记录外，没有其他低侵入的方式适配固定的“拆除-重部署”节奏。

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