Azure API Management でサブスクリプションを作成する

適用対象: すべての API Management レベル

Azure API Management を介して API を公開する場合、これらの API へのアクセスをセキュリティで保護する最も簡単で最も一般的な方法は、サブスクリプション キーを使用することです。 公開された API を使用する必要のあるクライアント アプリケーションには、このような API を呼び出すときに有効なサブスクリプション キーを HTTP 要求に含める必要があります。 API にアクセスするためのサブスクリプション キーを取得するには、サブスクリプションが必要です。 サブスクリプションの詳細については、「Subscriptions in Azure API Management」(Azure API Management のサブスクリプション) を参照してください。

この記事では、Azure portal でサブスクリプションを作成する手順について説明します。

前提条件

この記事の手順を実行するための前提条件は次のとおりです。

新しいサブスクリプションを作成する

  1. Azure portal で API Management インスタンスに移動します。

  2. 左側のメニューの [API] で、[サブスクリプション]>[サブスクリプションの追加] を選択します。

  3. サブスクリプションの名前とオプションの表示名を指定します。

  4. 必要に応じて、[トレースを許可] を選択して、API のデバッグとトラブルシューティングのためのトレースを有効にします。 詳細情報

    警告

    • デバッグの目的でのみサブスクリプションのトレースを許可します。 トレースが許可されたサブスクリプション キーを承認されていないユーザーと共有すると、キー、アクセス トークン、パスワード、内部ホスト名、IP アドレスなどのトレース ログに含まれる機密情報が漏えいする可能性があります。
    • テスト コンソールでは、API Management により、トレースはサブスクリプションで有効になってから 1 時間後に自動的に無効になります。

    Note

    現時点では、API 要求トレースは Basic v2 および Standard v2 レベルではサポートされていません。

  5. ドロップダウン リストから、サブスクリプションの [スコープ] を選択します。 詳細情報

  6. 必要に応じて、サブスクリプションをユーザーに関連付けるかどうか、および開発者ポータルで使用する通知を送信するかどうかを選択します。

  7. [作成] を選択します

ポータルでの API Management サブスクリプションの作成方法を示すスクリーンショット。

サブスクリプションを作成すると、[サブスクリプション] ページの 一覧に表示されます。 API にアクセスするための 2 つの API キーが提供されます。 一方のキーはプライマリで、他方のキーはセカンダリです。

次の手順

API Management の詳細情報: