Share via

Azure Functions に対する Dapr トピック トリガー

  • [アーティクル]

重要

Azure Functions の Dapr 拡張機能は現在プレビュー段階であり、Azure Container Apps 環境でのみサポートされています。

Azure Functions は、次の Dapr イベントを使って、Dapr トピック サブスクリプションでトリガーできます。

Dapr 拡張機能のセットアップと構成について詳しくは、Dapr 拡張機能の概要に関する記事をご覧ください。

例

A C# 関数は、次の C# モードのいずれかを使用して作成できます。

実行モデル 説明
分離ワーカー モデル 関数コードは、別の .NET ワーカー プロセスで実行されます。 .NET と .NET Framework のサポートされているバージョンで使います。 詳細については、.NET 分離ワーカー プロセス関数の開発に関する記事を参照してください。
インプロセス モデル 関数コードは、Functions ホスト プロセスと同じプロセスで実行されます。 .NET の長期サポート (LTS) バージョンのみをサポートします。 詳細については、.NET クラス ライブラリ関数の開発に関する記事を参照してください。 
[FunctionName("TransferEventBetweenTopics")]
public static void Run(
    [DaprTopicTrigger("%PubSubName%", Topic = "A")] CloudEvent subEvent,
    [DaprPublish(PubSubName = "%PubSubName%", Topic = "B")] out DaprPubSubEvent pubEvent,
    ILogger log)
{
    log.LogInformation("C# function processed a TransferEventBetweenTopics request from the Dapr Runtime.");


    pubEvent = new DaprPubSubEvent("Transfer from Topic A: " + subEvent.Data);
}

次に示すのは、Dapr トピック トリガーを使ってトピックをサブスクライブするための Java コードです。

@FunctionName("PrintTopicMessage")
public String run(
        @DaprTopicTrigger(
            pubSubName = "%PubSubName%",
            topic = "B")
        String payload,
        final ExecutionContext context) throws JsonProcessingException {
    Logger logger = context.getLogger();
    logger.info("Java function processed a PrintTopicMessage request from the Dapr Runtime.");

オブジェクトを app 使用して以下を登録します daprTopicTrigger。

const { app, trigger } = require('@azure/functions');

app.generic('TransferEventBetweenTopics', {
    trigger: trigger.generic({
        type: 'daprTopicTrigger',
        name: "subEvent",
        pubsubname: "%PubSubName%",
        topic: "A"
    }),
    return: daprPublishOutput,
    handler: async (request, context) => {
        context.log("Node function processed a TransferEventBetweenTopics request from the Dapr Runtime.");
        context.log(context.triggerMetadata.subEvent.data);

        return { payload: context.triggerMetadata.subEvent.data };
    }
});

次の例は、function.json ファイル内の Dapr トリガーと、それらのバインドを使用する PowerShell コードを示しています。

daprTopicTrigger の function.json ファイルを次に示します。

{
  "bindings": [
    {
      "type": "daprTopicTrigger",
      "pubsubname": "%PubSubName%",
      "topic": "B",
      "name": "subEvent",
      "direction": "in"
    }
  ]
}

function.json ファイルのプロパティについて詳しくは、「構成」セクションをご覧ください。

コード内で以下のように指定します。

using namespace System
using namespace Microsoft.Azure.WebJobs
using namespace Microsoft.Extensions.Logging
using namespace Microsoft.Azure.WebJobs.Extensions.Dapr
using namespace Newtonsoft.Json.Linq

param (
    $subEvent
)

Write-Host "PowerShell function processed a PrintTopicMessage request from the Dapr Runtime."

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $subEvent["data"] | ConvertTo-Json -Compress

Write-Host "Topic B received a message: $jsonString"

次に示すのは、v2 Python プログラミング モデルを使用する Dapr トピック トリガーの例です。 Python 関数アプリ コードで daprTopicTrigger を使用するには:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="PrintTopicMessage")
@app.dapr_topic_trigger(arg_name="subEvent", pub_sub_name="%PubSubName%", topic="B", route="B")
def main(subEvent) -> None:
    logging.info('Python function processed a PrintTopicMessage request from the Dapr Runtime.')
    subEvent_json = json.loads(subEvent)
    logging.info("Topic B received a message: " + subEvent_json["data"])

属性

インプロセス モデルでは、DaprTopicTrigger を使って、次のプロパティをサポートする Dapr パブリッシュ/サブスクライブ バインドをトリガーします。

パラメーター 説明
PubSubName Dapr パブリッシュ/サブスクライブの名前。
トピック Dapr トピックの名前。

注釈

DaprTopicTrigger 注釈を使用すると、トピックが受信されたときに実行する関数を作成できます。

要素 説明
pubSubName Dapr パブリッシュ/サブスクライブの名前。
topic Dapr トピックの名前。

構成

次の表では、コードで設定するバインド構成プロパティについて説明します。

プロパティ 説明
pubsubname Dapr パブリッシュ/サブスクライブ コンポーネントの種類の名前。
topic トピックの名前。

次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。

function.json のプロパティ 説明
pubsubname Dapr パブリッシュ/サブスクライブ コンポーネントの種類の名前。
topic トピックの名前。

次の表は、Python コードで設定する @dapp.dapr_topic_trigger のバインド構成プロパティについて説明しています。

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
pub_sub_name Dapr サブスクリプション コンポーネントの種類の名前。 ✔️ ❌
topic サブスクリプション トピック。 ✔️ ❌

完全な例については、セクションの例を参照してください。

使用法

Dapr トピック トリガーを使うには、最初に Dapr パブリッシュ/サブスクライブ コンポーネントを設定します。 使用するコンポーネントとその設定方法の詳細については、Dapr の公式ドキュメントを参照してください。

Python v2 で daprTopicTrigger を使用するには、正しい依存関係でプロジェクトを設定します。

  1. 仮想環境を作成してアクティブにする。

  2. requirements.text ファイルに、次の行を追加します。

    azure-functions==1.18.0b3

  3. ターミナルで、Python ライブラリをインストールします。

    pip install -r .\requirements.txt

  4. 次の構成で local.setting.json ファイルを変更します。

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

次のステップ

Dapr のパブリッシュとサブスクライブの詳細を理解する。