将 Azure API 管理实例部署到虚拟网络 - 外部模式

  • 项目

可将 Azure API 管理部署（注入）在 Azure 虚拟网络 (VNet) 内部，以访问该网络中的后端服务。 有关 VNet 连接选项、要求和注意事项，请参阅将虚拟网络与 Azure API 管理配合使用。

本文介绍如何在外部模式下为 API 管理实例设置 VNet 连接，在此模式下，可以从公共 Internet 访问开发人员门户、API 网关和其他 API 管理终结点，而后端服务位于网络中。

Connect to external VNet

对于特定于内部模式的配置（在此模式下，只能在 VNet 内部访问这些终结点），请参阅将 Azure API 管理实例部署到虚拟网络 - 内部模式。

注意

建议使用 Azure Az PowerShell 模块与 Azure 交互。 请参阅安装 Azure PowerShell 以开始使用。 若要了解如何迁移到 Az PowerShell 模块，请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az。

可用性

重要

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

先决条件

  • 虚拟网络和子网位于 API 管理实例所在的区域和订阅中。

    子网必须专用于 API 管理实例。 若尝试将 Azure API 管理实例部署到包含其他资源的资源管理器 VNET 子网，则部署将失败。

启用 VNet 连接

使用 Azure 门户启用 VNet 连接（stv2 计算平台）

  1. 转到 Azure 门户，查找 API 管理实例。 搜索并选择“API 管理服务”。

  2. 选择你的 API 管理实例。

  3. 选择“网络”。

  4. 选择“外部”访问类型。 Select VNet in Azure portal.

  5. 在预配了 API 管理服务的位置（区域）列表中：

    1. 选择“位置” 。
    2. 选择“虚拟网络”、“子网”和“IP 地址” 。

    • 系统将在 VNet 列表中填充你所配置区域内设置的 Azure 订阅中的可用资源管理器 VNet。

      VNet settings in the portal.

  6. 选择“应用”。 API Management 实例的“网络”页将使用新的 VNet 和子网选项进行更新。

  7. 继续为 API 管理实例的其余位置配置 VNet 设置。

  8. 在顶部导航栏中，选择“保存”，然后选择“应用网络配置”。

更新 API 管理实例可能需要 15 到 45 分钟。 开发人员层级在此过程中有故障时间。 基本 SKU 和更高级别的 SKU 在此过程中没有停机时间。

使用资源管理器模板（stv2 计算平台）启用连接

  • Azure 资源管理器模板（API 版本 2021-08-01）

    Deploy to Azure

使用 Azure PowerShell cmdlet 启用连接（stv1 平台）

在 VNet 中创建或更新 API 管理实例。

配置 NSG 规则

在 API 管理子网中配置自定义网络规则，以筛选进出 API 管理实例的流量。 建议使用以下最低 NSG 规则，以确保正确操作和访问实例。

重要

根据监视和其他功能的使用情况，可能需要配置下表中最小规则数之外的其他 NSG 规则。 有关详细设置，请参阅虚拟网络配置参考。

  • 在大多数情况下，请使用指示的服务标记（而不是服务 IP 地址）来指定网络源和目标。
  • 将这些规则的优先级设置为高于默认规则的优先级。
源/目标端口 方向 传输协议 服务标记
源/目标		 用途 VNet 类型
* / [80], 443 入站 TCP Internet / VirtualNetwork 客户端与 API 管理的通信 仅外部
* / 3443 入站 TCP ApiManagement / VirtualNetwork Azure 门户和 PowerShell 的管理终结点 外部和内部
* / * 入站 TCP AzureLoadBalancer / VirtualNetwork Azure 基础结构负载均衡器（高级服务层级所需） 外部和内部
* / 443 出站 TCP VirtualNetwork / Storage 与 Azure 存储的依赖关系 外部和内部
* / 1433 出站 TCP VirtualNetwork / SQL 访问 Azure SQL 终结点 外部和内部

连接到托管在虚拟网络中的 Web 服务

将 API 管理服务连接到 VNet 后，可像访问公共服务一样访问 VNet 中的后端服务。 创建或编辑 API 时，请在“Web 服务 URL”字段键入 Web 服务的本地 IP 地址或主机名（如果为 VNet 配置了 DNS 服务器）。

Add API from VNet

自定义 DNS 服务器设置

在外部 VNet 模式下，DNS 默认由 Azure 管理。 可以选择性地配置自定义 DNS 服务器。

API 管理服务依赖于多项 Azure 服务。 当 API 管理托管在包含自定义 DNS 服务器的 VNet 中时，API 管理需要解析这些 Azure 服务的主机名。

重要

如果你打算为 VNet 使用自定义 DNS 服务器，请先进行相应设置，然后将 API 管理服务部署到 VNet 中。 否则，每次通过运行应用网络配置操作更改 DNS 服务器时，都需要更新 API 管理服务。

路由

  • 负载均衡的公共 IP 地址 (VIP) 将会保留，以用于访问 VNet 外部的 API 管理终结点和资源。
    • 可以在 Azure 门户中的“概述/概要”边栏选项卡上找到公共 VIP。

有关详细信息和注意事项，请参阅 Azure API 管理的 IP 地址。

VIP 和 DIP 地址

动态 IP (DIP) 地址将分配给服务中每个基础虚拟机，用于访问 VNet 和对等 VNet 中的终结点和资源。 API 管理服务的公共虚拟 IP (VIP) 地址将用于访问面向公共的资源。

如果使用 IP 限制列表保护 VNet 或对等 VNet 内的资源，那么建议指定部署 API 管理服务的整个子网范围，以授予或限制该服务的访问权限。

详细了解建议的子网大小。

使用 ExpressRoute 或网络虚拟设备，强制通过隧道将流量传输到本地防火墙

借助强制隧道，可将来自子网的全部 Internet 绑定流量重定向或“强制”返回到本地位置，以进行检查和审核。 通常可以通过配置及定义自己的默认路由 (0.0.0.0/0)，以使来自 API 管理子网的所有流量强制穿过本地防火墙或流入网络虚拟设备。 此流量流会中断与 API 管理的连接，因为出站流量会在本地遭到阻止，或者已经过 NAT 处理，变为一组无法再与各种 Azure 终结点配合工作的无法识别的地址。 可通以下方法解决此问题：

  • 在部署以下服务的 API 管理所在的子网上启用服务终结点：

    • Azure SQL（仅在 API 管理服务部署到多个区域的情况下主要区域才需要使用）
    • Azure 存储
    • Azure 事件中心
    • Azure 密钥保管库（在 stv2 平台上部署 API 管理时需要）

    通过直接从 API 管理子网为这些服务启用终结点，可以使用 Azure 主干网络为服务流量提供最佳路由。 如果使用带有强制隧道的 API 管理服务终结点，前面的 Azure 服务的流量就不会强制通过隧道传输。 其他 API 管理服务依赖项流量将依然强制通过隧道传输。 确保防火墙或虚拟设备不会阻止此流量，否则 API 管理服务可能无法正常工作。

    注意

    强烈建议直接从 API 管理子网为支持服务终结点的依赖服务（例如 Azure SQL 和 Azure 存储）启用服务终结点。 但是，某些组织可能要求强制通过隧道传送来自API 管理子网的所有流量。 在这种情况下，请确保将防火墙或虚拟设备配置为允许此流量。 你需要允许每个依赖服务的完整 IP 地址范围，并在 Azure 基础结构更改时使此配置保持最新。 由于强制通过隧道传送此网络流量，API 管理服务也可能会遇到延迟或意外超时。

  • 所有从 Internet 传输至 API 管理服务之管理终结点的控制平面流量均通过由 API 管理托管的一组特定入站 IP 进行路由。 当强制通过隧道传输流量时，响应不会对称地映射回这些入站源 IP，并且与管理终结点的连接也会丢失。 若要克服此限制，请为这些入站 IP 配置用户定义的路由 (UDR)，并将下一跃点类型设置为“Internet”，以将流量引导回 Azure。 配置 ApiManagement 服务标记，或者找到控制平面 IP 地址中记录的控制平面流量的入站 IP 集。

    重要

    请仅在某些网络方案需要控制平面 IP 地址时，才为网络访问规则和路由配置这些 IP 地址。 建议使用 ApiManagement 服务标记而不要使用控制平面 IP 地址，以防止在基础结构的改进需要对 IP 地址进行更改时出现停机。

    注意

    允许“API 管理”的管理流量绕过本地防火墙或网络虚拟应用程序不视为重大安全风险。 API 管理子网的推荐配置只允许来自 ApiManagement 服务标记所包含的 Azure IP 地址集的端口 3443 入站管理流量。 建议的 UDR 配置仅适用于此 Azure 流量的返回路径。

  • （外部 VNet 模式）尝试从 Internet 访问API 管理网关和开发人员门户的客户端数据平面流量也将默认删除，因为强制隧道引入了非对称路由。 对于需要访问权限的每个客户端，请配置下一跃点类型为“Internet”的显式 UDR，以绕过防火墙或虚拟网络设备。

  • 对于强制通过隧道传输流量的其他 API 管理服务依赖项，应解析主机名并访问相应终结点。 其中包括:

    • 指标和运行状况监视
    • Azure 门户诊断
    • SMTP 中继
    • 开发人员门户验证码
    • Azure KMS 服务器

有关更多信息，请参阅虚拟网络配置参考。

常见网络配置问题

本部分已移到其他位置。 请参阅虚拟网络配置参考。

疑难解答

  • 在子网中初次部署 API 管理服务失败
    • 将虚拟机部署到相同子网。
    • 连接到虚拟机，并验证与 Azure 订阅中以下其中一项资源的连接：
      • Azure 存储 Blob
      • Azure SQL 数据库
      • Azure 存储表
      • Azure Key Vault

重要

验证连接性后，先删除子网中的所有资源，然后再将 API 管理部署到子网。

  • 验证网络连接状态

    • 在将 API 管理部署到子网后，应使用门户来检查实例与依赖项（如 Azure 存储）之间的连接性。
    • 在门户的左侧菜单中的“部署和基础结构”下，选择“网络连接状态” 。

    Verify network connectivity status in the portal

    筛选器 说明
    必需 选择“必需”，以查看 API 管理与必需 Azure 服务之间的连接性。 如果失败，则表示该实例无法执行核心操作来管理 API。
    可选 选择“可选”，以查看 API 管理与可选服务之间的连接性。 如果连接失败，仅表示特定功能（如 SMTP）将无法正常工作。 连接失败可能会导致使用和监视 API 管理实例以及提供所承诺 SLA 的能力下降。

    若要解决连接问题，请查看网络配置设置并修复所需的网络设置。

  • 增量更新
    更改网络时，请参阅 NetworkStatus API，以验证 API 服务是否仍具有关键资源的访问权限。 连接状态应每 15 分钟更新一次。

    若要使用门户来应用对 API 管理实例的网络配置更改，请执行以下操作：

    1. 在实例的左侧菜单中的“部署和基础结构”下，选择“虚拟网络”。
    2. 选择“应用网络配置”。

  • 资源导航链接
    托管在计算平台上的 APIM 实例在部署到某个资源管理器 VNET 子网后，将通过创建资源导航链接来保留该子网。 如果子网已包含来自其他提供程序的资源，则部署将失败。 同样，当删除 API 管理服务或将其移至其他子网时，资源导航链接也将会删除。

后续步骤

了解有关以下方面的详细信息：