如何为已部署的Azure API Management添加主机配置

你尝试通过Bicep为已部署的APIM添加新主机配置时遇到了两个问题：

• 直接修改APIM资源的hostnameConfigurations会替换现有配置，而非增量新增
• 通过网关子资源添加主机配置的方式未生效

问题原因分析 #

1. 全量替换导致覆盖
   第一种方式中，你直接给hostnameConfigurations赋值新数组，Bicep对现有资源的属性采用全量更新逻辑，会直接覆盖原有所有主机配置，而非追加。

2. 资源类型使用错误
   第二种方式用到的Microsoft.ApiManagement/service/gateways/hostnameConfigurations是为自定义网关配置域名的资源类型，并非用于APIM默认网关的自定义域名配置，所以无法满足你的需求。

正确解决方案：增量追加主机配置 #

要实现新增主机配置，需先引用现有APIM资源，读取其已有的hostnameConfigurations，再将新配置合并到数组中进行更新。

步骤1：引用现有APIM资源

// 引用已部署的APIM实例
resource existingApim 'Microsoft.ApiManagement/service@2021-08-01' existing = {
  name: replace(resourceGroup().name, '-rg', '-apim')
}

步骤2：定义新的自定义域名配置

// 配置新的自定义域名参数
var newCustomDomain = {
  type: customDomainType // 可选值：Proxy、Portal、Management、Scm等
  hostName: customDomainHostName // 你的自定义域名，比如 api.example.com
  keyVaultId: 'https://${existing_keyvault.name}.vault.azure.net/secrets/${customDomainKVCert}' // 密钥保管库中证书的路径
  enforceHttps: true // 可选：强制HTTPS访问
}

步骤3：更新APIM资源，合并配置

// 更新APIM，将新配置追加到现有主机配置列表
resource updatedApim 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: existingApim.name
  location: existingApim.location
  identity: existingApim.identity // 保留原有身份配置
  sku: existingApim.sku // 保留原有SKU配置
  properties: {
    publisherEmail: existingApim.properties.publisherEmail
    publisherName: existingApim.properties.publisherName
    // 合并现有配置与新配置，实现增量添加
    hostnameConfigurations: concat(existingApim.properties.hostnameConfigurations, [newCustomDomain])
  }
}

关键注意事项 #

• 确保APIM的系统分配身份拥有密钥保管库的Get密钥权限，否则无法读取证书内容
• customDomainType需与域名用途匹配，比如Proxy对应API访问入口，Portal对应开发者门户
• 如果同一类型的域名已存在（如已有Proxy类型域名），需根据需求选择替换或确保新域名唯一

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