Azure API Management で Azure Function App を API としてインポートする

[アーティクル]
06/01/2023

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

Azure API Management は、Azure Function App の新しい API としてのインポートや既存の API への追加をサポートします。プロセスが自動的に Azure Function App 内にホストキーを生成して、Azure API Management 内の名前付きの値に割り当てます。

この記事では、Azure API Management で Azure Function App を API としてインポートしてテストする手順について説明します。

学習内容:

Azure Function App の API としてのインポート
Azure Function App の API への追加
新しい Azure Function App のホストキーと Azure API Management の名前付きの値の表示
Azure Portal での API のテスト

前提条件

Azure API Management インスタンスの作成に関するクイックスタートを完了します。
サブスクリプションに Azure Functions アプリがあることを確認します。詳細については、Azure Function App の作成に関するページを参照してください。関数は HTTP トリガーを備えていること、また承認レベルが Anonymous または Function に設定されていることが必要です。

Note

Visual Studio Code 用の API Management 拡張機能を使用して API をインポートおよび管理できます。 API Management 拡張機能のチュートリアルに従ってインストールしてから作業を開始してください。

API Management インスタンスに移動します。

Azure portal で、[API Management サービス] を検索して選択します。
[API Management サービス] ページで、ご自身の API Management インスタンスを選択します。

Azure Function App を新しい API としてインポートする

以下の手順に従って、Azure Function App から新しい API を作成します。

Azure portal で API Management サービスに移動し、メニューから [API] を選択します。
[Add a new API](新しい API の追加) の一覧で [Functions App](Function App) を選択します。
[参照する] をクリックして、インポートする Function を選択します。
[Functions App](Function App) セクションをクリック、使用可能な Function App の一覧から選択します。
関数のインポート元となる Function App を検索してクリックし、 [選択] をクリックします。
インポートする Function を選択して、 [選択] をクリックします。
- インポートできるのは、承認レベルが Anonymous または Function に設定された、HTTP トリガーに基づく関数のみです。
[完全] ビューに切り替え、 [製品] を新しい API に割り当てます。
必要に応じて、作成時に他のフィールドを指定することも、後で [設定] タブで構成することもできます。
- 設定については、「最初の API のインポートと発行」のチュートリアルで説明されています。
Note

成果物は、開発者ポータルを通じて開発者に提供される 1 つまたは複数の API を関連付けたものです。開発者は、まず成果物をサブスクライブして API へのアクセス権を取得する必要があります。サブスクライブすると、その成果物の API に使用されるサブスクリプションキーが提供されます。 API Management インスタンスの作成者は管理者となるため、既定ですべての製品をサブスクライブすることになります。

すべての API Management インスタンスは、既定のサンプル成果物を 2 つ備えています。
- スターター
- 無制限
Create をクリックしてください。

Azure Function App を既存の API に追加する

以下の手順に従って、Azure Function App を既存の API に追加します。

お使いの Azure API Management サービスインスタンスで、左側のメニューから [API] を選択します。
Azure Function App のインポート先となる API を選択します。 [...] をクリックして、コンテキストメニューから [インポート] を選択します。
[Function App] タイルをクリックします。
ポップアップウィンドウで、 [参照] をクリックします。
[Functions App](Function App) セクションをクリック、使用可能な Function App の一覧から選択します。
関数のインポート元となる Function App を検索してクリックし、 [選択] をクリックします。
インポートする Function を選択して、 [選択] をクリックします。
[インポート] をクリックします。

承認

Azure Function App のインポートによって、次が自動的に生成されます。

apim-{<お使いの Azure API Management サービスインスタンス名>} という名前の、Function App 内のホストキー。
{<お使いの Azure Function App のインスタンス名>}-key という名前の、Azure API Management インスタンス内の名前付きの値。作成されたホストキーが含まれます。

2019 年 4 月 4 日より後に作成された API では、ホストキーが HTTP 要求のヘッダーで API Management から Function App に渡されます。以前の API では、ホストキーがクエリパラメーターとして渡されます。この動作は、関数アプリに関連付けられている Backend エンティティの PATCH BackendREST API 呼び出しを通じて変更できます。

警告

Azure Function App のホストキーの値または Azure API Management の名前付きの値のいずれかを削除または変更すると、サービス間の通信が失われます。値は自動的に同期されません。

ホストキーを交換する必要がある場合は、Azure API Management の名前付きの値も変更されることを確認します。

Azure Function App のホストキーにアクセスする

お使いの Azure Function App のインスタンスに移動します。
サイドナビゲーションメニューの [関数] セクションで [アプリキー] を選択します。

$[Function App settings]$Function App の設定$ オプションが強調表示されているスクリーンショット。$
[ホストキー] セクションでキーを見つけます。

Azure API Management の名前付きの値にアクセスする

お使いの Azure API Management インスタンスに移動し、左側のメニューから [API] をクリックします。 Azure Function App のキーは、そこに格納されています。

Function App から追加する

Azure portal での新しい API のテスト

操作は Azure portal から直接呼び出すことができます。 Azure portal は API の操作を表示およびテストするのに便利です。

テスト手順が強調表示されているスクリーンショット。

前のセクションで作成した API を選択します。
[テスト] タブを選びます。
テストする操作を選択します。
- ページに、クエリパラメーターとヘッダーのフィールドが表示されます。
- この API に関連付けられている成果物のサブスクリプションキーの場合、ヘッダーの 1 つは "Ocp-Apim-Subscription-Key" です。
- API Management インスタンスの作成者は、既に管理者になっているので、キーが自動的に入力されます。
[Send] を選択します。
- テストが成功すると、バックエンドから 200 OK およびいくつかのデータが応答として返されます。

次のステップ

公開された API の変換と保護