API ManagementからAPIキーを用いてAzure Functionsへアクセスしてみた｜ITエンジニアとして経験・学習したこと

以前、Azure FunctionsへのアクセスにAPIキーを必須にしてみたことがあったが、このAzure Functionsの呼び出しをAPI Managementを経由して行うこともできる。

今回は、Azure API Managementを経由して、APIキーが必要なAzure Functionsを呼び出してみたので、その手順を共有する。

なお、Azure FunctionsへのアクセスにAPIキーを必須にする対応については、以下の記事を参照のこと。

Azure FunctionsへのアクセスにAPIキーを必須にしてみたこれまでは、Azure Functionsのアクセス権限をAnonymous(匿名)にしていて、APIキーが不要でもアクセスできていたが...

前提条件

下記記事の実装が完了していること。

API Managementのアクセスをサブスクリプション必須にしてみたAzure API Managementを経由してAzure Functionsを呼び出す際、サブスクリプションの指定をしないと、Azu...

また、以下の記事のPostmanをインストール済であること。

POSTメソッドでリクエストされるAzure FunctionsのAPIをPostmanによって呼び出してみたAzure App Serviceを利用せずに、HTTPトリガーによって呼び出されるAzure Functionsの動作確認を行うには、...

作成したサンプルプログラム(Azure Functions側)の内容

作成したサンプルプログラム(Azure Functions側)の構成は以下の通り。

なお、上記の赤枠は、前提条件のプログラムから変更したプログラムである。また、App Service側のソースコードは修正していない。

ハンドラークラスの内容は以下の通りで、権限レベル(authLevel )をANONYMOUSからFUNCTIONに変更している。

package com.example;

import java.util.Optional;

import org.springframework.cloud.function.adapter.azure.FunctionInvoker;

import com.example.model.SearchParam;
import com.example.model.SearchResult;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.microsoft.azure.functions.ExecutionContext;
import com.microsoft.azure.functions.HttpMethod;
import com.microsoft.azure.functions.HttpRequestMessage;
import com.microsoft.azure.functions.HttpResponseMessage;
import com.microsoft.azure.functions.HttpStatus;
import com.microsoft.azure.functions.annotation.AuthorizationLevel;
import com.microsoft.azure.functions.annotation.FunctionName;
import com.microsoft.azure.functions.annotation.HttpTrigger;

public class CallFunctionApiHandler extends FunctionInvoker<SearchParam, SearchResult> {

    /**
     * HTTP要求に応じて、DemoAzureFunctionクラスのcallFunctionApiメソッドを呼び出し、
     * その戻り値をボディに設定したレスポンスを返す.
     * @param request リクエストオブジェクト
     * @param context コンテキストオブジェクト
     * @return レスポンスオブジェクト
     */
    @FunctionName("callFunctionApi")
    public HttpResponseMessage execute(
            @HttpTrigger(name = "request", methods = HttpMethod.POST
               , authLevel = AuthorizationLevel.FUNCTION) 
                   HttpRequestMessage<Optional<String>> request,
            ExecutionContext context) {

        // リクエストオブジェクトからパラメータ値を取得し、検索用パラメータに設定する
        ObjectMapper mapper = new ObjectMapper();
        String jsonParam = request.getBody().get();
        jsonParam = jsonParam.replaceAll("\\[", "").replaceAll("\\]", "");

        SearchParam searchParam = new SearchParam();
        try {
            searchParam = mapper.readValue(jsonParam
               , new TypeReference<SearchParam>() {
            });
        } catch (Exception ex) {
            throw new RuntimeException(ex);
        }

        // handleRequestメソッド内でDemoAzureFunctionクラスのcallFunctionApiメソッドを呼び出し、
        // その戻り値をボディに設定したレスポンスを、JSON形式で返す
        return request.createResponseBuilder(HttpStatus.OK)
                .body(handleRequest(searchParam, context))
                .header("Content-Type", "text/json").build();
    }
}

package com.example;

import java.util.Optional;

import org.springframework.cloud.function.adapter.azure.FunctionInvoker;

import com.example.model.SearchParam;

import com.example.model.SearchResult;

import com.fasterxml.jackson.core.type.TypeReference;

import com.fasterxml.jackson.databind.ObjectMapper;

import com.microsoft.azure.functions.ExecutionContext;

import com.microsoft.azure.functions.HttpMethod;

import com.microsoft.azure.functions.HttpRequestMessage;

import com.microsoft.azure.functions.HttpResponseMessage;

import com.microsoft.azure.functions.HttpStatus;

import com.microsoft.azure.functions.annotation.AuthorizationLevel;

import com.microsoft.azure.functions.annotation.FunctionName;

import com.microsoft.azure.functions.annotation.HttpTrigger;

public class CallFunctionApiHandler extends FunctionInvoker<SearchParam, SearchResult> {

/**

* HTTP要求に応じて、DemoAzureFunctionクラスのcallFunctionApiメソッドを呼び出し、

* その戻り値をボディに設定したレスポンスを返す.

* @param request リクエストオブジェクト

* @param context コンテキストオブジェクト

* @return レスポンスオブジェクト

@FunctionName("callFunctionApi")

public HttpResponseMessage execute(

@HttpTrigger(name = "request", methods = HttpMethod.POST

, authLevel = AuthorizationLevel.FUNCTION)

HttpRequestMessage<Optional<String>> request,

ExecutionContext context) {

// リクエストオブジェクトからパラメータ値を取得し、検索用パラメータに設定する

ObjectMapper mapper = new ObjectMapper();

String jsonParam = request.getBody().get();

jsonParam = jsonParam.replaceAll("\\[", "").replaceAll("\\]", "");

SearchParam searchParam = new SearchParam();

try {

searchParam = mapper.readValue(jsonParam

, new TypeReference<SearchParam>() {

});

} catch (Exception ex) {

throw new RuntimeException(ex);

}

// handleRequestメソッド内でDemoAzureFunctionクラスのcallFunctionApiメソッドを呼び出し、

// その戻り値をボディに設定したレスポンスを、JSON形式で返す

return request.createResponseBuilder(HttpStatus.OK)

.body(handleRequest(searchParam, context))

.header("Content-Type", "text/json").build();

}

その他のソースコード内容は、以下のサイトを参照のこと。
https://github.com/purin-it/azure/tree/master/api-management-api-key-functions/demoAzureFunc

また、ソースコードを修正後、Azure上にデプロイする。なお、Azure Functionsにデプロイする過程は、以下の記事の「Azure FunctionsへのSpring Bootを利用したJavaアプリケーションのデプロイ」を参照のこと。

Azure Functions上でSpring Bootを利用したJavaアプリケーションを作成してみた前回は、Azure Potal上でAzure Functionsを作成してみたが、今回は、前回作成したAzure FunctionsにS...

Azure環境でのAzure FunctionsのAPI呼出し

Postmanを利用して、Azure環境でのAzure FunctionsやAPI ManagementのAPIを呼び出した結果は、以下の通り。

1) 以下のように、Headerにx-functions-keyの値を指定しないでAzure環境でのAzure FunctionsのAPIを呼び出すと、401エラーが発生する。

なお、このとき指定するAPIの「https://azurefuncdemoapp.azurewebsites.net」の部分は、Azure Portal上のAzure FunctionsのURLから確認できる。

2) 以下のように、Headerにx-functions-keyの値を指定してAzure環境でのAzure FunctionsのAPIを呼び出すと、正常にレスポンスが返ることが確認できる。

なお、このときのx-functions-keyに指定する値は、以下の画面から確認できる。

また、リクエストボディには、paramの値を指定している。

3) HeaderにOcp-Apim-Subscription-Keyの値を指定して、Azure環境でAPI Management経由でAzure FunctionsのAPIを呼び出すと、正常にレスポンスが返ることが確認できる。なお、Ocp-Apim-Subscription-Keyの値については、前提条件の記事と同じ指定をしている。

なお、このときのOcp-Apim-Subscription-Keyの値は、以下の画面の主キーを表示することによって確認できる。

また、指定するAPIの「https://azureapipurinit.azure-api.net/azureFuncDemoApp」の部分は、Azure Portal上のAPI Managementの「Base URL」から確認できる。

さらに、リクエストボディには、Azure FunctionsのAPI呼出時と同じように、paramの値を指定している。

4) Azure環境でAPI Management経由でAzure FunctionsのAPIを呼び出す際、前提条件の記事と同じ指定で正常にレスポンスが返却される背景としては、API Management上に追加した「callFunctionApi」APIで、「set-backend-service」ポリシーが追加されているためである。