新しい開発者ポータルへの移行

  • [アーティクル]

この記事では、API Management で非推奨のレガシ ポータルから新しい開発者ポータルに移行するために必要な手順について説明します。

重要

従来の開発者ポータルは非推奨となり、セキュリティ更新プログラムのみを受け取るようになりました。 2023 年 10 月に廃止され、すべての API Management サービスから削除されるまで、通常どおりに引き続き使用できます。

API Management 開発者ポータル

可用性

重要

この機能は、API Management の Premium、Standard、Basic、Developer レベルで使用できます。

v2 レベル (プレビュー) での機能の可用性については、 v2 レベルの概要に関するページを参照してください。

新しい開発者ポータルの機能強化

新しい開発者ポータルは、非推奨のポータルの多くの制限に対処しています。 コンテンツを編集するためのビジュアル ドラッグ アンド ドロップ エディターと、デザイナーが Web サイトのスタイルを設定するための専用パネルを備えています。 ページ、カスタマイズ、および構成は、API Management サービスに Azure Resource Manager リソースとして保存されます。これにより、ポータルのデプロイを自動化することができます。 最後に、ポータルのコードベースはオープンソースであるため、カスタム機能を使用して拡張することができます。

新しい開発者ポータルへの移行方法

新しい開発者ポータルは、非推奨のポータルとは互換性がなく、自動移行はできません。 コンテンツ (ページ、テキスト、メディア ファイル) を手動で再作成し、新しいポータルの外観をカスタマイズする必要があります。 正確な手順は、ご使用のポータルのカスタマイズと複雑さによって異なります。 ガイダンスについては、開発者ポータルのチュートリアルを参照してください。 API、製品、ユーザー、ID プロバイダーのリストなどの残りの構成は、両方のポータル間で自動的に共有されます。

重要

以前に新しい開発者ポータルを起動したことがあるが、変更を加えていない場合は、既定のコンテンツをリセットして、最新バージョンに更新してください。

非推奨のポータルから移行する場合は、次の変更に注意してください。

  • カスタム ドメインを使用して開発者ポータルを公開する場合は、新しい開発者ポータルにドメインを割り当てます。 Azure portal のドロップダウンから [開発者ポータル] オプションを使用します。

  • API に CORS ポリシーを適用して、対話型のテスト コンソールを有効にします。

  • ポータルのスタイルを設定するためにカスタム CSS を挿入する場合は、組み込みのデザイン パネルを使用してスタイル設定をレプリケートする必要があります。 CSS インジェクションは新しいポータルでは許可されていません。

  • カスタム JavaScript を挿入できるのは、新しいポータルのセルフホステッド バージョンだけです。

  • API Management が仮想ネットワーク内にあり、Application Gateway を介してインターネットに公開されている場合、詳細な構成手順については、このドキュメントの記事を参照してください。 以下を実行する必要があります。

    • API Management の管理エンドポイントへの接続を有効にします。
    • 新しいポータル エンドポイントへの接続を有効にします。
    • 選択した Web Application Firewall 規則を無効にします。

  • 明示的に定義された非推奨のポータル URL を含めるように既定の電子メール通知テンプレートを変更した場合は、ポータルの URL パラメーターを使用するか、新しいポータルの URL を指すようにそれらを変更します。 代わりに組み込みポータルの URL パラメーターがテンプレートで使用されている場合、変更は必要ありません。

  • "イシュー" と "アプリケーション" は、新しい開発者ポータルではサポートされていません。

  • ID プロバイダーとしての Facebook、Microsoft、Twitter、および Google との直接統合は、新しい開発者ポータルではサポートされていません。 Azure AD B2C を経由してこれらのプロバイダーと統合できます。

  • 委任を使用する場合は、アプリケーションの戻り先 URL を変更し、"SSO URL の生成" エンドポイントの代わりに、"共有アクセス トークンの取得" API エンドポイントを使用します。

  • ID プロバイダーとして Microsoft Entra ID を使用する場合:

    • アプリケーションの戻り先 URL を、新しい開発者ポータル ドメインを指すように変更します。
    • アプリケーションの戻り先 URL のサフィックスを /signin-aad から /signin に変更します。

  • Azure AD B2C を ID プロバイダーとして使用する場合は、次のことを行います。

    • アプリケーションの戻り先 URL を、新しい開発者ポータル ドメインを指すように変更します。
    • アプリケーションの戻り先 URL のサフィックスを /signin-aad から /signin に変更します。
    • アプリケーション要求に、"名"、"姓"、"ユーザーのオブジェクト ID" を含めます。

  • 対話型テスト コンソールで OAuth 2.0 を使用する場合は、アプリケーションの戻り先 URL を変更して、新しい開発者ポータル ドメインを指定し、次のようにサフィックスを変更します。

    • 承認コードの付与フローの場合は、/docs/services/[serverName]/console/oauth2/authorizationcode/callback から /signin-oauth/code/callback/[serverName]。
    • 暗黙的な許可フローの場合は、/docs/services/[serverName]/console/oauth2/implicit/callback から /signin-oauth/implicit/callback。

  • 対話型テスト コンソールで OpenID Connect を使用する場合は、アプリケーションの戻り先 URL を変更して、新しい開発者ポータル ドメインをポイントし、次のようにサフィックスを変更します。

    • 承認コードの付与フローの場合は、/docs/services/[serverName]/console/openidconnect/authorizationcode/callback から /signin-oauth/code/callback/[serverName]。
    • 暗黙的な許可フローの場合は、/docs/services/[serverName]/console/openidconnect/implicit/callback から /signin-oauth/implicit/callback。

次の手順

開発者ポータルの詳細については、次を参照してください。