为自托管网关配置自定义域名

可用性

重要

此功能在 API 管理的“高级”和“开发人员”层中可用。

预配自承载 Azure API 管理网关时,系统不会为其分配主机名,必须按其 IP 地址引用它。 本文介绍如何将现有的自定义 DNS 名称(也称为主机名)映射到自承载网关。

先决条件

若要执行本文中所述的步骤,必须具有:

  • 一个有效的 Azure 订阅。

    如果没有 Azure 订阅,可在开始前创建一个试用帐户

  • API 管理实例。 有关详细信息,请参阅创建 Azure API 管理实例

  • 一个自承载网关。 有关详细信息,请参阅如何预配自承载网关

  • 由你或你的组织拥有的自定义域名。 本主题不会提供有关如何购买自定义域名的说明。

  • DNS 服务器上承载的一条 DNS 记录,用于将自定义域名映射到自承载网关的 IP 地址。 本主题不会提供有关如何承载 DNS 记录的说明。

  • 必须具有有效的带有公钥和私钥 (.PFX) 的证书。 使用者或使用者可选名称 (SAN) 必须与域名匹配(这使得 API 管理实例可以通过 TLS 安全地公开 URL)。

转到你的 API 管理实例

  1. 在 Azure 门户中搜索并选择“API 管理服务” 。

    选择“API 管理服务”

  2. 在“API 管理”服务页上,选择你的 API 管理实例。

    选择你的 API 管理实例

将自定义域证书添加到 API 管理服务

将自定义域证书 (.PFX) 文件添加到 API 管理实例,或引用存储在 Azure Key Vault 中的证书。 按照使用 Azure API 管理中的客户端证书身份验证来确保后端服务安全中的步骤操作。

注意

建议为自承载网关域使用密钥保管库证书。

使用 Azure 门户为自承载网关设置自定义域名

  1. 选择“部署和基础结构”下的“网关” 。
  2. 选择要为其配置域名的自承载网关。
  3. 在“设置”下选择“主机名”。
  4. 选择“+ 添加”。
  5. 在“名称”字段中输入主机名的资源名称。
  6. 在“主机名”字段中输入域名。
  7. 从“证书”下拉列表中选择证书。
  8. 如果通过此网关公开的任何 API 使用客户端证书身份验证,请选中“协商客户端证书”复选框。

    警告

    此设置由配置给网关的所有域名共享。

  9. 选择“添加”,将自定义域名分配到所选的自承载网关。

注意

如果使用自定义域连接到自承载网关的客户端预期会显示链中的所有中间证书,则必须将单个 CA 证书上传到API 管理服务,并将其与自承载网关相关联。 有关如何实现此目的的说明,请参阅为自承载网关创建自定义 CA

后续步骤

升级和缩放你的服务