API Management を使用した Azure サーバーレスへのデプロイ

ここでは、Azure API Management (APIM) へのデプロイについて詳しく説明します。
APIM には、HTTP Azure Functions やモバイル (Angular) アプリケーションサービスをデプロイできます。いずれの場合も、APIM へのデプロイはオプションですが、推奨されています。
先に進む前に、「HTTP トリガーの Azure Functions」をお読みください。

モバイルアプリケーションサービスを Azure サーバーレスアーキテクチャへデプロイする場合は、 [ アプリケーションをデプロイ ] でデプロイターゲットとして Microsoft Azure サーバーレス (バックエンドサービス) を使用します。
Azure サーバーレスへデプロイする前に、[ Generate OpenAPI interface ] プロパティを Yes に設定し、 [ OpenAPI version ] プロパティを 2.0 か 3.0 のいずれかに設定して、モデルで「すべてリビルド」を実行する必要があります。
プロパティが設定されていなかった場合、次のような内容のエラーが表示されます:
「エラー: デプロイメントユニットのすべてのオブジェクトで [ Generate OpenAPI Interface ] プロパティを Yes に設定する必要があります。あるいは、ジェネレーターレベルでプロパティを Yes に設定し、すべてリビルドを実行してください。」
KB サービス (REST サービス、API オブジェクト) をデプロイするときは、デプロイターゲットとして Microsoft Azure Functions を使用します。

APIM へのデプロイのプロパティ

APIM へデプロイするには、GeneXus 内の [ デプロイ ] ダイアログの [ API Management Settings ] にある次のデプロイ関連プロパティを設定する必要があります:

[ APIM service name ]	API Management サービスインスタンスの名前です。
[ APIM resource group ]	Azure API Management のリソースグループです。
[ API Identification ]	API のリビジョン識別子です。現在の API Management サービスインスタンスで一意である必要があります。
[ API display name ]	この API の表示名です。
[ API backend service URL ]	この API を実装するバックエンドサービスの絶対 URL です。 Azure Function App に付与された URL に対応します。例: https://MyFunctionApp.azurewebsites.net
[ API path ]	API Management サービスインスタンス内で、この API とそのすべてのリソースパスを一意に識別する相対 URL です。例: travel
[ API subscription required ]	True の場合、API にはリクエスト時にサブスクリプションキーが必要となります。モバイルクライアントからサービスを呼び出す場合に推奨される値は False です。

例

次のデプロイ設定を考えます:

上記の設定では、API は Azure ポータルで次のように表示されます (API Management サービスを経由):

アプリケーションを実行し、デプロイしたサービスを使用するには、[ Services URL ] プロパティを次のように設定します:

この URL は、Azure ポータルで APIM サービスに表示されるゲートウェイ URL に、デプロイ時に設定した API パスを付加したものです。
実行時には、次の図に示すように、モバイルクライアントからの呼び出し時に URL の末尾に /rest が自動的に追加されます:

参考情報

バックエンドのデプロイに Azure サーバーレスを使用する Angular のフロントエンドアプリケーションについては、次を参照してください: サーバーレスバックエンドを使用した Angular フロントエンドアプリケーションのデプロイ方法。

APIM へのデプロイのプロパティ

例

参考情報

関連リンク