API 版本停用（2024 年 6 月）

适用于：消耗 | 开发人员 | 基本 | 标准 | 高级

Azure API 管理使用 Azure 资源管理器 (ARM) 来配置 API 管理实例。 API 版本嵌入在使用模板（用于描述基础结构）、工具（用于配置服务）以及程序（为管理 Azure API 管理服务而编写）的过程中。

从 2024 年 6 月 1 日开始，2021-08-01 之前 Azure API Management 服务的所有 API 版本将停用（禁用）。 此前传达的停用日期为 2023 年 9 月 30 日。 在 2024 年 6 月 1 日之后的任何时间，使用 2021-08-01 之前的 API 版本的 API 调用可能会失败，恕不另行通知。 在更新为使用 API 版本 2021-08-01 或更高版本之前，将无法再使用停用的 API 版本通过现有模板、工具、脚本和程序创建或管理 API Management 服务。 数据平面操作（如在网关中调解 API 请求）将不受此更新影响，包括 2024 年 6 月 1 日之后。

此更改是否会影响我的服务？

虽然服务不受此更改的影响，但使用 Azure 资源管理器（例如 Azure CLI、Azure PowerShell、Azure API Management DevOps 资源工具包或 Terraform）与 API Management 服务交互并调用 2021-08-01 之前的 API Management API 版本的任何工具、脚本或程序会受到此更改的影响。 API 版本停用后，除非更新工具，否则将无法成功运行任何受影响的工具。

此更改的截止时间是什么？

从 2024 年 6 月 1 日起，受影响的 API 版本将逐渐停用。

API 版本停用后，如果不想更新受影响的工具、脚本和程序，服务将继续运行。 但是，你将无法添加或删除 API、更改 API 策略，或者使用受影响的工具配置 API Management 服务。

必需的操作

使用以下部分中的详细信息更新工具、脚本和程序。

我们还建议在 API 管理实例中设置最低 API 版本。

更新工具、脚本和程序

• ARM、Bicep 或 Terraform 模板 - 更新模板，以使用 API 版本 2021-08-01 或更高版本。

• Azure CLI - 运行 az version 以检查版本。 如果运行的是 2.42.0 或更高版本，则无需执行任何操作。 必要时，使用 az upgrade 命令升级 Azure CLI。 有关详细信息，请参阅如何更新 Azure CLI。

• Azure PowerShell - 运行 Get-Module -ListAvailable -Name Az 以检查版本。 如果运行的是 8.1.0 或更高版本，则无需执行任何操作。 必要时，使用 Update-Module -Name Az -Repository PSGallery 更新模块。 有关详细信息，请查看安装 Azure Az PowerShell 模块。

• 其他工具 - 使用以下版本（或更高版本）：

  • API 管理 DevOps 资源工具包：1.0.0
  • Terraform Azure 提供程序：3.0.0

• Azure SDK - 将 Azure API Management SDK 更新到最新版本或至少以下版本：

  • .NET：v1.1.0
  • Go：1.0.0
  • Python：3.0.0
  • JavaScript：8.0.1
  • Java：1.0.0-beta3

更新 API 管理实例上的最低 API 版本设置

建议使用 Azure 门户、REST API 或其他工具为 API 管理实例设置“最低 API 版本”。 此设置限制对实例的控制平面 API 调用，其 API 版本等于或高于此值。 通过将此值设置为 2021-08-01，可以评估 API 版本停用对工具的影响。

若要在门户中设置最低 API 版本，请执行以下操作：

1. 在 Azure 门户，导航到 API 管理实例。
2. 在左侧菜单中的“部署 + 基础结构”下，选择“管理 API”。
3. 选择“管理 API 设置”选项卡。
4. 在“强制执行最低 API 版本”下，选择“是”。 此时会显示“最低 API 版本”。
5. 选择“保存”。

详细信息

• 支持的 API Management API 版本
• Azure CLI
• Azure PowerShell
• Azure Resource Manager
• Bicep

相关内容

查看所有即将推出的中断性变更和功能停用。