共用方式為

API 版本淘汰 (2024 年 6 月)

  • 發行項

適用於：取用 |開發人員 |基本 |標準 |進階版

Azure API 管理會使用 Azure Resource Manager (ARM) 來設定您的 API 管理執行個體。 API 版本會內嵌在您用來描述基礎結構的範本、用於設定服務的工具，以及您撰寫以管理 Azure API 管理服務的程式中。

從 2024 年 6 月 1 日起，Azure API 管理 服務的所有 API 版本在 2021-08-01 之前即將淘汰（停用）。 先前傳達的退休日期是 2023 年 9 月 30 日。 在 2024 年 6 月 1 日之後的任何時間，使用 2021-08-01 之前的 API 版本進行 API 呼叫可能會失敗，而不需進一步通知。 在已更新為使用 API 版本 2021-08-01 或更新版本之前，您將無法使用淘汰的 API 版本，建立或管理具有現有範本、工具、腳稿和程式 API 管理 服務。 數據平面作業（例如在閘道中調解 API 要求）不會受到此更新影響，包括 2024 年 6 月 1 日之後。

我的服務是否受到此影響？

雖然您的服務不受這項變更影響，但任何使用 Azure Resource Manager 的工具、腳本或程式（例如 Azure CLI、Azure PowerShell、Azure API 管理 DevOps Resource Kit 或 Terraform）與 API 管理 服務互動，並呼叫 2021-08-01 之前的 API 管理 API 版本，都會受到這項變更的影響。 在 API 版本淘汰之後，除非您更新工具，否則您將無法成功執行任何受影響的工具。

變更的最後期限為何？

受影響的 API 版本將從 2024 年 6 月 1 日起逐漸淘汰。

在 API 版本淘汰之後，如果您不想更新受影響的工具、腳本和程式，您的服務將會繼續執行。 不過，您將無法使用受影響的工具來新增或移除 API、變更 API 原則，或設定 API 管理 服務。

必要的動作

使用下一節的詳細數據來更新您的工具、腳本和程式。

我們也建議您在 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 PowerShell 模組。

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

    • API 管理 DevOps 資源套件：1.0.0
    • Terraform azurerm 提供者：3.0.0

  • Azure SDK - 將 Azure API 管理 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 版本] 呈現灰色，您就只能以程式設計方式更新設定，例如，在 Azure CLI 中使用 REST API 或 az apim update 命令。

其他相關資訊

相關內容

查看所有即將推出的重大變更和功能淘汰。