API バージョンの廃止 (2024 年 6 月)

  • [アーティクル]

適用対象: Consumption | Developer | Basic | Standard | Premium

Azure API Management は、Azure Resource Manager (ARM) を使用して、API Management インスタンスを構成します。 API バージョンは、インフラストラクチャを記述するテンプレート、サービスの構成に使用されるツール、Azure API Management サービスを管理するために記述するプログラムを使用する際に埋め込まれます。

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 Resource Manager (Azure CLI、Azure PowerShell、Azure API Management DevOps Resource Kit、Terraform など) を使用して API Management サービスと対話し、2021-08-01 より前の API Management API バージョンを呼び出すツール、スクリプト、またはプログラムは、この変更の影響を受けます。 API バージョンが廃止されると、ツールを更新しない限り、影響を受けるツールを正常に実行できなくなります。

変更の期日

影響を受ける API バージョンは、2024 年 6 月 1 日から徐々に廃止されます。

API バージョンが廃止された後、影響を受けるツール、スクリプト、およびプログラムを更新しない場合、サービスは引き続き実行されます。 ただし、API を追加または削除したり、API ポリシーを変更したり、影響を受けるツールを使用して API Management サービスを構成したりすることはできません。

必要なアクション

次のセクションの詳細を使用して、ツール、スクリプト、およびプログラムを更新します。

また、API Management インスタンスで 最小 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 Management DevOps リソース キット: 1.0.0
    • Terraform azurerm プロバイダー: 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 Management インスタンスの最小 API バージョン設定を更新する

Azure portal または REST API またはその他のツールを使用して、API Management インスタンスの最小 API バージョンを設定することをお勧めします。 この設定により、インスタンスに対するコントロール プレーン API 呼び出しは、この値以上の API バージョンに制限されます。 この値を 2021-08-01 に設定すると、API バージョンの提供終了がツールに与える影響を評価できます。

ポータルで 最小 API バージョン を設定するには:

  1. Azure portal で、API Management インスタンスに移動します。
  2. 左側のメニューの [デプロイとインフラストラクチャ] で、[管理 API] を選択します。
  3. [Management API settings]\(管理 API 設定\) タブを選択します。
  4. [最小 API バージョンの適用] で、[はい] を選択します。 最小 API バージョンが表示されます。
  5. [保存] を選択します。

重要

ポータルの最小 API バージョンが淡色表示されている場合は、プログラムでのみ設定を更新できます。たとえば、Azure CLI で REST API または az apim update コマンドを使用します。

詳細

関連するコンテンツ

予定されているすべての破壊的変更と機能の廃止に関する記事を参照してください。