The English version of quarkus.io is the official project site. Translated sites are community supported on a best-effort basis.
Back to Guides
このページを編集

Azure Functions

プレビュー

quarkus-azure-functions エクステンションは、Azure Functions と Quarkus のシンプルな統合ポイントです。Azure Functions ランタイムと連携して Quarkus をブートストラップし、記述する Azure Functions クラスを CDI/ArC Bean に変換します。

これにより、Quarkus によって初期化された任意のサービスやコンポーネントを、関数クラスに直接注入できます。関数クラスをシングルトンにしたい場合は、関数クラスのライフサイクルをリクエストスコープ (デフォルト) からアプリケーションスコープに変更することも可能です。

この技術は、previewと考えられています。

preview では、下位互換性やエコシステムでの存在は保証されていません。具体的な改善には設定や API の変更が必要になるかもしれませんが、 stable になるための計画は現在進行中です。フィードバックは メーリングリスト や GitHub の課題管理 で受け付けています。

とりうるステータスの完全なリストについては、 FAQの項目 を参照してください。

 
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;

import jakarta.inject.Inject;
import java.util.Optional;

public class Function {
    @Inject
    GreetingService service;

    @FunctionName("HttpExample")
    public HttpResponseMessage run(
            @HttpTrigger(
                name = "req",
                methods = {HttpMethod.GET, HttpMethod.POST},
                authLevel = AuthorizationLevel.ANONYMOUS)
                HttpRequestMessage<Optional<String>> request,
            final ExecutionContext context) {

        // Parse query parameter
        final String query = request.getQueryParameters().get("name");
        final String name = request.getBody().orElse(query);

        if (name == null) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST).body("Please pass a name on the query string or in the request body").build();
        } else {
            return request.createResponseBuilder(HttpStatus.OK).body(service.greeting(name)).build();
        }
    }
}

要件

このガイドを完成させるには、以下が必要です:

ソリューション

このガイドでは、HTTP Trigger Azure Function クラスをデプロイできる Maven プロジェクトの実行方法を説明します。この関数クラスは、クライアントに返される挨拶メッセージを生成する CDI Bean サービスを注入します。

Maven/Gradleプロジェクトの作成

まず、新しいプロジェクトが必要です。以下のコマンドで新規プロジェクトを作成します:

コマンドラインインタフェース
quarkus create app org.acme:azure-functions-quickstart \
    --extension='quarkus-azure-functions'
cd azure-functions-quickstart

Gradleプロジェクトを作成するには、 --gradle または --gradle-kotlin-dsl オプションを追加します。

Quarkus CLIのインストールと使用方法の詳細については、 Quarkus CLI ガイドを参照してください。

Maven
mvn io.quarkus.platform:quarkus-maven-plugin:3.35.2:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=azure-functions-quickstart \
    -Dextensions='quarkus-azure-functions'
cd azure-functions-quickstart

Gradleプロジェクトを作成するには、 -DbuildTool=gradle または -DbuildTool=gradle-kotlin-dsl オプションを追加します。

Windowsユーザーの場合:

  • cmdを使用する場合、（バックスラッシュ \ を使用せず、すべてを同じ行に書かないでください）。

  • Powershellを使用する場合は、 -D パラメータを二重引用符で囲んでください。例: "-DprojectArtifactId=azure-functions-quickstart"

このコマンドは、Quarkus Azure Functions HTTP エクステンションをインポートするプロジェクト構造を生成します。例も含まれています。

プロジェクトの確認

生成されたプロジェクトの pom.xml または build.gradle ビルドファイルを開くと、そのプロジェクトが他の Quarkus プロジェクトと同様であることがわかります。quarkus-azure-functions エクステンションは、Quarkus と Azure Functions の間の統合ポイントです。これは、Azure Functions ランタイムにコールバックを登録して Quarkus をブートストラップし、Quarkus/ArC を関数クラスの関数ファクトリーとして設定します。

quarkus-azure-functions エクステンションの現在の実装では、azure-functions-maven-plugin または Gradle の同等のものが不要になりました。ローカル開発と Azure Functions のパッケージングおよびデプロイは、すべて Quarkus によって行われます。

ビルド設定はすべて application.properties 内にあります。唯一必要な設定スイッチ は quarkus.azure-functions.app-name です。

Azureデプロイメントディスクリプタ

Azure Functions の`host.json`デプロイメント記述子は自動的に 生成されますが、オーバーライドする必要がある場合は、プロジェクトの root ディレクトリーで宣言し、 準備ができたらビルドを再実行します。

Quarkus dev mode

Quarkusの開発モードは、現在Azure Functionsでは動作しません。

Azure Functionsローカル環境での実行

ローカルの Azure Functions 環境でアプリケーションを試したい場合は、次のコマンドを使用できます。

コマンドラインインタフェース
quarkus run
Maven
./mvnw quarkus:run
Gradle
./gradlew --console=plain --info --no-daemon quarkusRun

Gradle はプロセス管理に少し癖があるため、--no-daemon スイッチが必要です。そうしないと、Control-C でプロセスが正常に破棄されず、開いたポートが残ってしまいます。

これが機能するには、 Azure Functions Core Tools がインストールされている必要があります。

例題にアクセスするためのURLは次のようになります:

https://localhost:8081/HttpExample?name=Bill

Quarkus統合テスト

@QuarkusIntegrationTest の機能を使用して統合テストを実装できます。これらの統合テストが実行されると、 統合テストの間、ローカルの Azure Functions 環境がスピンアップされます。

Maven
./mvnw verify
Gradle
./gradlew --info quarkusIntTest

Maven で実行する統合テストが *IT.java ファイルパターンを使用していることを確認してください。これにより、通常のビルドでそのテストが実行されなくなります。

Gradle で実行する統合テストが src/integrationTest/java 内にあることを確認してください。src/test に存在する統合テスト は通常のビルドで実行され、失敗します。

Azureへのログイン

アプリケーションを Azure にデプロイするには、Azure にログインしてください:

az login

Azureへのデプロイ

quarkus-azure-functions エクステンションは、Azure へのデプロイに関するすべての作業を処理します。デフォルトでは、Quarkus はバックグラウンドで Azure CLI を使用して Azure に対して認証を行い、デプロイします。アカウントに複数のサブスクリプションが関連付けられている場合、application.properties ファイルの quarkus.azure-functions.subscription-id プロパティーを、使用したいサブスクリプションに設定する必要があります。その他の認証メカニズムおよびデプロイオプションについては、設定プロパティー Azure Functions 設定リファレンス を参照してください。

アプリケーションをデプロイするには、プロジェクトをビルドした後、次を実行します:

Maven
./mvnw quarkus:deploy
Gradle
./gradlew --info deploy

Gradle の場合、この出力を確認するには --info スイッチを使用する必要があります。

デプロイメントが成功すると、Quarkus はサンプル関数のエンドポイント URL をコンソールに出力します:

[INFO] HTTP Trigger Urls:
[INFO] 	 HttpExample : https://{appName}.azurewebsites.net/api/httpexample

サービスにアクセスするための URL は次のようになります: https://{appName}.azurewebsites.net/api/HttpExample

Azure Functions 設定リファレンス

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは実行時にオーバーライド可能

Configuration property

タイプ

デフォルト

quarkus.azure-functions.app-name

App name for azure function project. This is required setting. Defaults to the base artifact name

Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_NAME

Show more

string

quarkus.azure-functions.resource-group

Azure Resource Group for your Azure Functions

Environment variable: QUARKUS_AZURE_FUNCTIONS_RESOURCE_GROUP

Show more

string

quarkus

quarkus.azure-functions.region

Specifies the region where your Azure Functions will be hosted; default value is westus. Valid values

Environment variable: QUARKUS_AZURE_FUNCTIONS_REGION

Show more

string

westus

quarkus.azure-functions.disable-app-insights

Specifies whether to disable application insights for your function app

Environment variable: QUARKUS_AZURE_FUNCTIONS_DISABLE_APP_INSIGHTS

Show more

boolean

false

quarkus.azure-functions.app-insights-key

Specifies the instrumentation key of application insights which will bind to your function app

Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_INSIGHTS_KEY

Show more

string

quarkus.azure-functions.runtime.os

Valid values are linux, windows, and docker

Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_OS

Show more

string

linux

quarkus.azure-functions.runtime.java-version

Should be set to at least the minimum Quarkus compatible version

Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_JAVA_VERSION

Show more

string

17

quarkus.azure-functions.runtime.image

URL of docker image if deploying via docker

Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_IMAGE

Show more

string

quarkus.azure-functions.runtime.registry-url

If using docker, url of registry

Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_REGISTRY_URL

Show more

string

quarkus.azure-functions.auth.type

Description of each type can be found here Valid values are

  • azure_cli Delegates to Azure CLI for login

  • managed_identity Requires client to be set

  • oauth2 Requires tenant to be set

  • device_code Requires tenant to be set

  • file Filesystem path to a property file that defines authentication. Properties supported are

  • type Supports same type values as well as service_principal

  • client

  • tenant

  • key Password for service_principal if using password authentication

  • certificate Path to PEM file if using service_principal

  • certificate-password Password for PEM file if it is password protected and if using service_principal

  • environment if using service_principal

Defaults to "azure_cli" for authentication

Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_TYPE

Show more

string

azure_cli

quarkus.azure-functions.auth.path

Filesystem path to properties file if using file type

Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_PATH

Show more

string

quarkus.azure-functions.auth.client

Client or App Id required if using managed_identity type

Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_CLIENT

Show more

string

quarkus.azure-functions.auth.tenant

Tenant ID required if using oauth2 or device_code type

Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_TENANT

Show more

string

quarkus.azure-functions.app-service-plan-name

Specifies the name of the existing App Service Plan when you do not want to create a new one.

Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_SERVICE_PLAN_NAME

Show more

string

java-functions-app-service-plan

quarkus.azure-functions.app-service-plan-resource-group

The app service plan resource group.

Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_SERVICE_PLAN_RESOURCE_GROUP

Show more

string

quarkus.azure-functions.subscription-id

Azure subscription id. Required only if there are more than one subscription in your account

Environment variable: QUARKUS_AZURE_FUNCTIONS_SUBSCRIPTION_ID

Show more

string

quarkus.azure-functions.pricing-tier

The pricing tier.

Environment variable: QUARKUS_AZURE_FUNCTIONS_PRICING_TIER

Show more

string

quarkus.azure-functions.func-port

Port to run azure function in local runtime. Will default to quarkus.http.test-port or 8081

Environment variable: QUARKUS_AZURE_FUNCTIONS_FUNC_PORT

Show more

int

quarkus.azure-functions.local-debug-config

Config String for local debug

Environment variable: QUARKUS_AZURE_FUNCTIONS_LOCAL_DEBUG_CONFIG

Show more

string

transport=dt_socket,server=y,suspend=n,address=5005

関連コンテンツ

同じトピックについて

Quarkus はオープンです。このプロジェクトのすべての依存関係は、Apache Software License 2.0 または互換性のあるライセンスの下で利用可能です。 CC by 3.0

このウェブサイトは Jekyll で構築され、GitHub Pages でホストされており、完全にオープンソースです。改善したい場合は、ウェブサイトをフォークして、あなたのアイデアを見せてください。

ナビゲーション
フォローする
ヘルプ
言語
Quarkusはコミュニティプロジェクトで構成されています
Copyright © Quarkus. All rights reserved. For details on our trademarks, please visit our Trademark Policy and Trademark List. Trademarks of third parties are owned by their respective holders and their mention here does not suggest any endorsement or association.