VNet に挿入されていない API Management インスタンスを stv2 コンピューティング プラットフォームに移行する
適用対象: Developer | Basic | Standard | Premium
この記事では、API Management インスタンスが外部または内部の VNet に挿入 (デプロイ) されて "いない" 場合に、stv1 コンピューティング プラットフォームでホストされているインスタンスをインプレースで stv2 プラットフォームに移行する手順について説明します。 このシナリオでは、Azure portal または stv2 への移行 REST API を使ってインスタンスを移行します。 これを行う必要があるかどうかを確認してください。
stv1 プラットフォームでホストされている、"VNnet に挿入されている" API Management を移行する必要がある場合は、VNet に挿入されている API Management インスタンスの stv2 プラットフォームへの移行に関する記事をご覧ください。
重要
stv1 プラットフォームでホストされている API Management インスタンスのサポートは廃止処理中です。 グローバル Azure では、 2024 年 8 月 31 日が廃止の期限です。 Azure Government と 21Vianet (中国の Azure) が運営する Azure では、 2025 年 2 月 24 日に廃止されます。 stv1 プラットフォームでホストされているインスタンスをご使用の場合は、サービスの中断を回避するため、この日付より前に stv2 プラットフォームへ移行してください。
注意事項
- 新しいインフラストラクチャへの API Management インスタンスの移行は、実行するのに時間がかかる操作です。
- 移行のプロセスによっては、移行の間に一時的にダウンタイムが発生する可能性があり、移行後に API Management インスタンスにアクセスするためにネットワークの依存関係の更新が必要になる場合があります。 移行を適切に計画してください。
stv2への移行は元に戻すことはできません。
移行の間の動作
API Management プラットフォームを stv1 から stv2 に移行する際には、基になるコンピューティングのみが更新され、ストレージ レイヤーに存在するサービスおよび API 構成への影響はありません。 VNet にデプロイされていないインスタンスの場合:
- インスタンスの VIP アドレスを変更するか、それとも元の VIP アドレスを維持するかを選択できます。
- アップグレード プロセスでは、古いコンピューティングと並行して新しいコンピューティングが作成されます。
- ポータルで、API Management の状態が [更新中] になります。
- VIP アドレスを維持することを選んだ場合、移行には、古いコンピューティングから新しいコンピューティングに VIP を移動する追加のステップが含まれ、その間、API が応答しなくなります。
- Azure によって管理エンドポイントの DNS が管理され、移行が正常に完了するとすぐに新しいコンピューティングに更新されます。
- 既定のゲートウェイとポータルの DNS は、すぐに新しいコンピューティングを指すようになります。
- API Management インスタンスが新しい VIP アドレスを受け取るようにする場合は、新しい VIP アドレスを使うようにネットワークの依存関係を更新する必要があります。
前提条件
stv1コンピューティング プラットフォームでホストされている API Management インスタンス。 インスタンスがstv1プラットフォームでホストされていることを確認するには、「API Management インスタンスのホストとなっているプラットフォームは、どのようにして確認できますか?」を参照してください。
Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。
CLI リファレンス コマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、Azure CLI でのサインインに関するページを参照してください。
初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。 拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。
az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。
インスタンスを stv2 プラットフォームに移行する
パブリック IP アドレスのオプション
API Management の仮想 IP アドレスを変更するか、それとも元の VIP アドレスを保持するかを選択できます。
新しい仮想 IP アドレス - このモードを選んだ場合、移行の間も API 要求への応答は維持されます。 インフラストラクチャの構成 (カスタム ドメイン、場所、CA 証明書など) は 30 分間ロックされます。 移行後に、新しい VIP アドレスを使うには、DNS、ファイアウォール規則、VNet などのネットワーク依存関係を更新する必要があります。
IP アドレスを保持する - VIP アドレスを保持すると、IP アドレスが新しいインフラストラクチャに移行されている間に、約 15 分間、API 要求に応答できなくなります。 インフラストラクチャの構成 (カスタム ドメイン、場所、CA 証明書など) は 45 分間ロックされます。 移行後にそれ以上の構成は必要ありません。
移行用に事前に作成された IP アドレス
パブリック IP アドレスによって到達可能な API Management インスタンスの場合、API Management は、移行プロセスのパブリック IP アドレスを事前に作成します。 事前に作成された IP アドレスは、API Management インスタンスのプロパティの JSON 出力で確認できます。 customProperties において、事前作成 IP アドレスは Microsoft.WindowsAzure.ApiManagement.Stv2MigrationPreCreatedIps プロパティの値です。 マルチリージョンのデプロイの場合、この値は事前に作成された IP アドレスのコンマ区切りのリストです。
事前に作成された IP アドレスを使用すると、移行プロセスの管理に便利です。
- VIP アドレスを保持して移行する場合は、元の IP アドレスが
stv2デプロイに割り当てられる前に、事前に作成された IP アドレスが新しいstv2デプロイに一時的に割り当てられます。 たとえば、API Management インスタンスにアクセスを制限するファイアウォール規則がある場合は、事前作成 IP アドレスを許可リストに追加すると、移行中もクライアント アクセスの継続性を維持できます。 移行が完了したら、この事前作成 IP アドレスを許可リストから削除できます。 - 移行の際に新しい VIP アドレスを生成する場合は、移行中に事前作成 IP アドレスが新しい
stv2デプロイに割り当てられ、移行が完了した後も保持されます。 事前作成 IP アドレスを使用して DNS やファイアウォール規則などのネットワーク依存関係を更新し、新しい IP アドレスを指すように変更します。
移行の手順
Azure portal で、API Management インスタンスに移動します。
左側のメニューの [設定] で、[Platform migration] (プラットフォームの移行) を選びます。
[Platform migration] (プラットフォームの移行) ページで、2 つの移行オプションのいずれかを選びます。
新しい仮想 IP アドレス。 API Management インスタンスの VIP アドレスは、自動的に変更されます。 サービスにダウンタイムは発生しませんが、移行後に、新しい VIP アドレスを使うには、DNS、ファイアウォール規則、VNet などのネットワーク依存関係を更新する必要があります。
[Preserve IP address] (IP アドレスを保持する) -API Management インスタンスの VIP アドレスは変更されません。 インスタンスで最大 15 分間のダウンタイムが発生します。
移行プロセスのガイダンスを確認して、環境を準備します。
準備手順が完了したら、[I have read and understand the impact of the migration process] (移行プロセスの影響を読み、理解しました) を選びます。[移行] を選びます。
移行を検証する
移行が成功したことを確認するには、状態が [オンライン] に変わったら、API Management インスタンスのプラットフォーム バージョンを調べます。 移行が成功すると、値は stv2 または stv2.1 になります。
移行が失敗した場合は自動的に元に戻す
移行プロセス中にエラーが発生した場合、インスタンスは自動的に stv1 プラットフォームに戻ります。 移行が正常に完了した場合 (インスタンスのプラットフォーム バージョンは stv2 または stv2.1 として表示され、状態は [オンライン] として表示されます)、stv1 プラットフォームにロールバックすることはできません。
移行に失敗した場合のヘルプについては、Azure サポートにお問い合わせください。
手動でロールバックできるようにする必要がある場合は、新しい stv2 インスタンスを元の API Management インスタンスと side-by-side でデプロイすることをお勧めします。
ネットワークの依存関係を更新する
新しい VIP アドレスへの移行が正常に完了したら、新しい VIP アドレスを使うように、DNS、ファイアウォール規則、VNet などのネットワーク依存関係を更新します。
ヘルプとサポート
サービスの中断を最小限に抑えながら、stv2 プラットフォームに移行できるようお手伝いします。
質問がある場合は、Microsoft Q&A でコミュニティの専門家が速やかにお答えします。 サポート プランに加入していて技術的な支援が必要な場合は、サポート リクエストを作成してください。
- [要約] に、問題の説明 (「stv1 の廃止」など) を入力します。
- [問題の種類] で [技術] を選択します。
- [サブスクリプション] でご使用のサブスクリプションを選択します。
- [サービス] で [使用中のサービス] を選択し、[API Management サービス] を選択します。
- [リソース] で、サポート リクエストを作成する Azure リソースを選択します。
- [問題の種類] で [管理] を選択します。
- [問題のサブタイプ] で [Upgrade, Scale or SKU Changes] (アップグレード、スケーリング、SKU の変更) を選択します。
よく寄せられる質問
移行パスを選ぶためにはどのような情報が必要ですか?
- API Management インスタンスのネットワーク モードは何ですか?
- カスタム ドメインが構成されているか?
- ファイアウォールが関係しているか?
- 関係する IP でアップストリーム/ダウンストリームに既知の依存関係があるか?
- 複数リージョンへのデプロイですか?
- 既存のインスタンスを変更可能であるか並行セットアップが必要であるか?
- ダウンタイムが発生してもかまわないか?
- 移行を営業時間外に実行できるか?
移行にはどのような前提条件がありますか?
VNet に挿入されていないインスタンスの場合、前提条件は必要ありません。 パブリック IP アドレスを保持して移行すると、API Management インスタンスが約 15 分間応答しなくなります。 新しい IP で API Management を使用できるようにする [新しい仮想 IP アドレス] オプションを選んだ場合は、ダウンタイムが発生しない可能性があります。 A レコードを使ってカスタム ドメインで構成されたインスタンスや、パブリック仮想 IP アドレスに対するネットワーク依存関係があるインスタンスでは、新しい仮想 IP アドレスを要求するときにダウンタイムが発生します。
移行によってダウンタイムが発生しますか?
VNet に挿入されていないインスタンスでは、元の IP アドレスを維持することを選んだ場合にのみ、約 15 分のダウンタイムが発生します。 一方、新しい IP アドレスを使って移行し、新しい IP に対するネットワーク依存関係がない場合は、ダウンタイムは発生しません。 ネットワーク依存関係には、CNAME のないカスタム ドメイン名、IP 許可リスト、ファイアウォール規則、VNet が含まれます。
移行により、または移行中に、データまたは構成が失われる可能性がありますか?
stv1からstv2への移行では、コンピューティング プラットフォームのみが更新され、内部ストレージ レイヤーは変更されません。 そのため、構成はすべて、移行プロセスの間も安全です。 これにはシステム割り当てマネージド ID が含まれ、有効になっている場合は維持されます。移行が正常に完了したことを確認するにはどうすればよいですか?
概要ページで状態が [オンライン] になっており、プラットフォーム バージョンとして
stv2かstv2.1が示されていれば、移行は正常に完了しています。 また、必要な接続すべてについて、ネットワーク ブレードにあるネットワーク状態が緑色で表示されていることを確認してください。ポータルを使って移行できますか?
はい。Azure portal の [プラットフォームの移行] ブレードで、VNet に挿入されていないインスタンスのための移行手順が示されます。
インスタンスの IP アドレスを保持できますか?
はい。IP アドレスを維持できますが、約 15 分のダウンタイムが発生します。
既存のインスタンスを変更しない移行パスはありますか?
はい。side-by-side での移行を行う必要があります。 つまり、新しい API Management インスタンスを、現在のインスタンスがある状態で作成し、その構成を新しいインスタンスにコピーします。
移行に失敗するとどうなりますか?
移行を開始した後、API Management インスタンスでプラットフォーム バージョンが
stv2またはstv2.1と示されず、状態が [オンライン] と示されない場合は、失敗している可能性があります。 サービスは自動的に前のインスタンスにロールバックされ、変更は加えられません。 問題がある場合は (状態が 2 時間以上 [更新中] と示されている場合など)、Azure サポートにお問い合わせください。移行中はどの機能を使えなくなりますか?
VNet に挿入されていないインスタンスの場合:
- 元の IP アドレスを維持することを選んだ場合: IP アドレスが新しいインフラストラクチャに移行されている間に、約 15 分間、API 要求に応答できなくなります。 インフラストラクチャ構成 (カスタム ドメイン、場所、CA 証明書など) は 45 分間ロックされます。
- 新しい IP アドレスへの移行を選んだ場合: 移行の間も API 要求に応答します。 インフラストラクチャ構成 (カスタム ドメイン、場所、CA 証明書など) は 30 分間ロックされます。 移行後に、新しい VIP アドレスを使うには、DNS、ファイアウォール規則、VNet などのネットワーク依存関係を更新する必要があります。
移行にはどのくらい時間がかかりますか?
移行全体の想定所要時間は約 45 分です。 移行が既に実行されたかどうかを知るには、インスタンスの状態が [オンライン] に戻っており [更新中] でないことを確認します。 2 時間以上 [更新中] になっている場合は、Azure サポートにお問い合わせください。
必要に応じて移行をロールバックできますか?
移行プロセスの間にエラーが発生した場合、インスタンスは自動的に
stv1プラットフォームにロールバックされます。 ただし、サービスが正常に移行された後、stv1プラットフォームにロールバックすることはできません。カスタム ドメインまたはプライベート DNS ゾーンで必要な変更はありますか?
VNet に挿入されていないインスタンスでは、IP が維持されている場合は変更は必要ありません。 新しい IP を使うことにした場合は、その IP を参照するカスタム ドメインを更新する必要があります。
stv1 インスタンスが複数の Azure リージョン (マルチリージョン) にデプロイされています。 stv2 にアップグレードするにはどうすればよいですか?
VNet に挿入されていない API Management の場合は、ポータルまたは Azure CLI を使用する移行手順のようにします。 すべてのリージョンが
stv2に移行されます。セルフホステッド ゲートウェイの場合はどのような考慮事項がありますか?
セルフホステッド ゲートウェイにおいてはユーザーは何も実行する必要がありません。 必要なのは、Azure 上で実行されている、
stv1プラットフォームの廃止に影響を受ける API Management インスタンスを移行することのみです。 なお、API Management インスタンスの構成エンドポイント用に新しい IP が存在する可能性があり、その IP に固定されているネットワーク制限を更新する必要があることにご注意ください。移行によって開発者ポータルにどのような影響がありますか?
開発者ポータルに影響はありません。 カスタム ドメインを使っている場合は、移行後に、有効な IP で DNS レコードを更新する必要があります。 ただし、既定のドメインを使っている場合は、移行が正常に完了するとそれらが自動的に更新されます。 開発者ポータルには、移行の間のダウンタイムはありません。
stv2 に移行するとコストに影響がありますか?
課金モデルは
stv2の場合も変わらず、移行中および移行後に追加コストが発生することはありません。stv1 から stv2 への移行には、どのような RBAC アクセス許可が必要ですか?
移行を行うユーザーやプロセスには、API Management インスタンスへの書き込みアクセス権が必要です。