如何通过Terraform（优先AzAPI）查询Azure VM自定义扩展存在性并删除

方法1：批量查询并删除所有目标扩展（推荐） #

通过azapi_resource_list数据源列出指定VM的所有扩展，筛选出需要删除的类型后，动态生成删除动作——只有当扩展存在时才会执行删除，避免不存在时的报错。

步骤1：查询VM的所有扩展 #

data "azapi_resource_list" "vm_extensions" {
  provider = azapi
  resource_group_name = var.data_factory.resource_group_name
  type = "Microsoft.Compute/virtualMachines/extensions@2023-03-01"
  # 过滤出目标VM的扩展，替换var.vm_name为你的VM名称变量
  filter = "contains(id, '/virtualMachines/${var.vm_name}/')"
}

# 筛选出需要删除的自定义扩展
# 如果你要删除所有类型的扩展，去掉下面的if条件；如果只删自定义脚本扩展，保留条件
locals {
  existing_custom_extensions = [
    for ext in data.azapi_resource_list.vm_extensions.resources : {
      name     = ext.name
      vm_name  = split("/", ext.id)[8] # 从资源ID中提取VM名称
    }
    if ext.type == "Microsoft.Compute.CustomScriptExtension"
  ]
}

步骤2：安全删除存在的扩展 #

resource "azapi_resource_action" "delete_vm_custom_extension" {
  provider             = azapi
  # 用VM名称+扩展名称作为唯一键，遍历筛选出的扩展列表
  for_each = { for ext in local.existing_custom_extensions : "${ext.vm_name}-${ext.name}" => ext }
  type        = "Microsoft.Compute/virtualMachines/extensions@2023-03-01"
  resource_id = "/subscriptions/${data.azurerm_client_config.this.subscription_id}/resourceGroups/${var.data_factory.resource_group_name}/providers/Microsoft.Compute/virtualMachines/${each.value.vm_name}/extensions/${each.value.name}"
  method      = "DELETE"
  response_export_values = ["*"]

  # 可选：确保删除完成后再部署新扩展，替换为你的新扩展资源
  depends_on = [azapi_resource.new_custom_extension]
}

方法2：检查单个扩展是否存在 #

如果你只需要删除特定名称的扩展，可使用azapi_resource数据源并设置optional = true——当扩展不存在时，数据源不会报错，仅返回空值，据此判断是否执行删除。

# 查询指定扩展，设置optional=true避免不存在时报错
data "azapi_resource" "target_extension" {
  provider = azapi
  resource_id = "/subscriptions/${data.azurerm_client_config.this.subscription_id}/resourceGroups/${var.data_factory.resource_group_name}/providers/Microsoft.Compute/virtualMachines/${var.vm_name}/extensions/${var.target_extension_name}"
  optional = true
}

# 仅当扩展存在时执行删除
resource "azapi_resource_action" "delete_vm_custom_extension" {
  provider             = azapi
  count = data.azapi_resource.target_extension.id != "" ? 1 : 0
  type        = "Microsoft.Compute/virtualMachines/extensions@2023-03-01"
  resource_id = data.azapi_resource.target_extension.id
  method      = "DELETE"
  response_export_values = ["*"]
}

关键注意事项 #

• 确保使用的AzAPI Provider版本 ≥1.5.0，以支持azapi_resource_list和optional参数。
• 新部署的自定义扩展需添加depends_on依赖删除动作，保证执行顺序为先删后装。
• 多VM场景下，可遍历VM列表，结合azapi_resource_list的filter实现批量处理。

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