Share via

Azure Functions の Dapr パブリッシュ出力バインド

  • [アーティクル]

重要

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

Dapr パブリッシュ出力バインドを使うと、関数の実行中に Dapr トピックにメッセージを発行できます。

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

例

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

実行モデル 説明
分離ワーカー モデル 関数コードは、別の .NET ワーカー プロセスで実行されます。 .NET と .NET Framework のサポートされているバージョンで使います。 詳細については、.NET 分離ワーカー プロセス関数の開発に関する記事を参照してください。
インプロセス モデル 関数コードは、Functions ホスト プロセスと同じプロセスで実行されます。 .NET の長期サポート (LTS) バージョンのみをサポートします。 詳細については、.NET クラス ライブラリ関数の開発に関する記事を参照してください。

次の例では、Dapr パブリッシュ出力バインドを使って、パブリッシュ/サブスクライブ コンポーネントとトピックに対して Dapr パブリッシュ操作を実行する方法を示します。

[FunctionName("PublishOutputBinding")]
public static void Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "topic/{topicName}")] HttpRequest req,
    [DaprPublish(PubSubName = "%PubSubName%", Topic = "{topicName}")] out DaprPubSubEvent pubSubEvent,
    ILogger log)
{
    string requestBody = new StreamReader(req.Body).ReadToEnd();
    pubSubEvent = new DaprPubSubEvent(requestBody);
}

次の例では、DaprPublishOutput バインドと DaprTopicTrigger を使って、"TransferEventBetweenTopics" 関数を作成します。

@FunctionName("TransferEventBetweenTopics")
public String run(
        @DaprTopicTrigger(
            pubSubName = "%PubSubName%",
            topic = "A")
            String request,
        @DaprPublishOutput(
            pubSubName = "%PubSubName%",
            topic = "B")
        OutputBinding<String> payload,
        final ExecutionContext context) throws JsonProcessingException {
    context.getLogger().info("Java function processed a TransferEventBetweenTopics request from the Dapr Runtime.");
}

次の例では、Dapr 発行出力バインドは、オブジェクトによって app 登録される HTTP トリガーとペアになっています。

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

app.generic('PublishOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "topic/{topicName}",
        name: "req"
    }),
    return: daprPublishOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");
        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { payload: payload };
    }
});

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

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

{
  "bindings": 
    {
      "type": "daprPublish",
      "direction": "out",
      "name": "pubEvent",
      "pubsubname": "%PubSubName%",
      "topic": "B"
    }
}

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

# Example to use Dapr Service Invocation Trigger and Dapr State Output binding to persist a new state into statestore
param (
    $subEvent
)

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

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

$messageFromTopicA = "Transfer from Topic A: $jsonString".Trim()

$publish_output_binding_req_body = @{
    "payload" = $messageFromTopicA
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name pubEvent -Value $publish_output_binding_req_body

次の例は、v2 Python プログラミング モデルを使用する Dapr パブリッシュ出力バインドを示したものです。 Python 関数アプリ コードで daprPublish を使用するには:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="TransferEventBetweenTopics")
@app.dapr_topic_trigger(arg_name="subEvent", pub_sub_name="%PubSubName%", topic="A", route="A")
@app.dapr_publish_output(arg_name="pubEvent", pub_sub_name="%PubSubName%", topic="B")
def main(subEvent, pubEvent: func.Out[bytes]) -> None:
    logging.info('Python function processed a TransferEventBetweenTopics request from the Dapr Runtime.')
    subEvent_json = json.loads(subEvent)
    payload = "Transfer from Topic A: " + str(subEvent_json["data"])
    pubEvent.set(json.dumps({"payload": payload}).encode('utf-8'))

属性

インプロセス モデルでは、DaprPublish を使って、次のパラメーターをサポートする Dapr パブリッシュ出力バインドを定義します。

function.json のプロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
PubSubName メッセージを送信するための Dapr パブリッシュ/サブスクライブの名前。 ✔️ ✔️
トピック メッセージを送信するための Dapr トピックの名前。 ✔️ ✔️
Payload 必須。 発行されるメッセージ。 ❌ ✔️

注釈

DaprPublishOutput 注釈を使うと、発行されたメッセージに関数がアクセスできるようになります。

要素 説明 Attribute を使って送信できる RequestBody を使って送信できる
pubSubName メッセージを送信するための Dapr パブリッシュ/サブスクライブの名前。 ✔️ ✔️
topic メッセージを送信するための Dapr トピックの名前。 ✔️ ✔️
payload 必須。 発行されるメッセージ。 ❌ ✔️

構成

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

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
pubsubname パブリッシャー コンポーネント サービスの名前。 ✔️ ✔️
topic パブリッシャー トピックの名前または識別子。 ✔️ ✔️
payload 必須。 発行されるメッセージ。 ❌ ✔️

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

function.json のプロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
pubsubname パブリッシャー コンポーネント サービスの名前。 ✔️ ✔️
topic パブリッシャー トピックの名前または識別子。 ✔️ ✔️
payload 必須。 発行されるメッセージ。 ❌ ✔️

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

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
pub_sub_name パブリッシャー イベントの名前。 ✔️ ✔️
topic パブリッシャー トピックの名前または識別子。 ✔️ ✔️
payload 必須。 発行されるメッセージ。 ❌ ✔️

プロパティが Attributes と RequestBody の両方で定義されている場合は、RequestBody で指定されているデータが優先されます。

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

使用法

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

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

  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 のパブリッシュとサブスクライブの詳細を理解する。