如何通过Bicep提取APIM自定义域名验证所需的apimuid验证ID？

APIM的自定义域名验证机制和Web Apps不同，验证ID不会直接暴露在服务的customProperties中，必须通过触发域名验证流程才能获取对应的TXT记录信息，以下是两种可行的实现方式：

方式一：在Bicep中同步定义自定义域名并生成验证TXT记录 #

你可以直接在Bicep中定义APIM的自定义域名资源，Azure会自动生成DNS验证所需的TXT记录名称和值，直接引用这些属性即可创建记录：

// 引用现有APIM服务
resource apim 'Microsoft.ApiManagement/service@2024-05-01' existing = {
  name: apimServiceName
  scope: resourceGroup()
}

// 添加APIM自定义域名并启用DNS验证
resource apimCustomDomain 'Microsoft.ApiManagement/service/customDomains@2024-05-01' = {
  parent: apim
  name: 'apiCustomDomain' // 自定义域名资源的名称，可按需修改
  properties: {
    hostName: 'api.yourdomain.com' // 你的目标自定义域名
    certificate: {
      // 根据证书类型配置，示例为Key Vault托管证书
      storeName: 'CertificateAuthority'
      keyVaultId: '/subscriptions/{你的订阅ID}/resourceGroups/{资源组名}/providers/Microsoft.KeyVault/vaults/{密钥库名}'
      keyVaultSecretName: '你的证书密钥名称'
      keyVaultSecretVersion: ''
    }
    validationMethod: 'dns' // 指定使用DNS验证
  }
}

// 调用模块创建验证TXT记录
module txt '../network/public-txt-record.module.bicep' = {
  name: 'txtModule'
  params: {
    publicDnsZoneName: publicDnsZoneName
    txtRecordName: apimCustomDomain.properties.validationState.dnsTxtRecordName
    txtRecordValue: [apimCustomDomain.properties.validationState.dnsTxtRecordValue] // TXT值需以数组形式传入（部分DNS模块要求）
  }
}

方式二：引用已存在的APIM自定义域名获取验证信息 #

如果已经通过门户或其他方式添加了自定义域名并触发了验证，可以直接引用现有自定义域名资源提取验证属性：

// 引用现有APIM服务
resource apim 'Microsoft.ApiManagement/service@2024-05-01' existing = {
  name: apimServiceName
  scope: resourceGroup()
}

// 引用已存在的APIM自定义域名资源
resource apimExistingCustomDomain 'Microsoft.ApiManagement/service/customDomains@2024-05-01' existing = {
  parent: apim
  name: '已存在的自定义域名资源名称'
}

// 创建验证TXT记录
module txt '../network/public-txt-record.module.bicep' = {
  name: 'txtModule'
  params: {
    publicDnsZoneName: publicDnsZoneName
    txtRecordName: apimExistingCustomDomain.properties.validationState.dnsTxtRecordName
    txtRecordValue: [apimExistingCustomDomain.properties.validationState.dnsTxtRecordValue]
  }
}

关键注意事项 #

• 必须确保使用的API版本（如示例中的2024-05-01）支持validationState属性，该属性在较旧的APIM API版本中不可用。
• TXT记录创建完成后，需等待DNS解析生效（通常数分钟到数小时），APIM会自动完成验证，验证通过后自定义域名状态会变为Valid。
• 验证完成后建议保留TXT记录，避免后续域名重新验证时出现问题。

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