次の方法で共有

Azure Functions の Dapr Binding 出力バインド

  • [アーティクル]

Dapr 出力バインドを使用すると、関数の実行中に値を Dapr 出力バインドに送信できます。

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

例

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

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

次の例では、Dapr サービス呼び出しトリガーと Dapr 出力バインドを使用して、バインド要求を読み取って処理する方法を示します。

[FunctionName("SendMessageToKafka")]
public static async Task Run(
    [DaprServiceInvocationTrigger] JObject payload,
    [DaprBinding(BindingName = "%KafkaBindingName%", Operation = "create")] IAsyncCollector<object> messages,
    ILogger log)
{
    log.LogInformation("C#  function processed a SendMessageToKafka request.");
    await messages.AddAsync(payload);
}

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

@FunctionName("SendMessageToKafka")
public String run(
        @DaprServiceInvocationTrigger(
            methodName = "SendMessageToKafka") 
        String payload,
        @DaprBindingOutput(
            bindingName = "%KafkaBindingName%", 
            operation = "create")
        OutputBinding<String> product,
        final ExecutionContext context) {
    context.getLogger().info("Java  function processed a SendMessageToKafka request.");
    product.setValue(payload);

    return payload;
}

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

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

app.generic('SendMessageToKafka', {
    trigger: trigger.generic({
        type: 'daprServiceInvocationTrigger',
        name: "payload"
    }),
    return: daprBindingOuput,
    handler: async (request, context) => {
        context.log("Node function processed a SendMessageToKafka request from the Dapr Runtime.");
        context.log(context.triggerMetadata.payload)

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

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

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

{
  "bindings": 
    {
      "type": "daprBinding",
      "direction": "out",
      "bindingName": "%KafkaBindingName%",
      "operation": "create",
      "name": "messages"
    }
}

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

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

using namespace System.Net

# Input bindings are passed in via param block.
param($req, $TriggerMetadata)

Write-Host "Powershell SendMessageToKafka processed a request."

$invoke_output_binding_req_body = @{
    "data" = $req
}

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

次の例は、v2 Python プログラミング モデルを使用する Dapr Binding 出力バインドを示したものです。 Python 関数アプリ コードで @dapp.dapr_binding_output を使用するには:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="SendMessageToKafka")
@app.dapr_service_invocation_trigger(arg_name="payload", method_name="SendMessageToKafka")
@app.dapr_binding_output(arg_name="messages", binding_name="%KafkaBindingName%", operation="create")
def main(payload: str, messages: func.Out[bytes]) -> None:
    logging.info('Python processed a SendMessageToKafka request from the Dapr Runtime.')
    messages.set(json.dumps({"data": payload}).encode('utf-8'))

属性

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

パラメーター 説明 Attribute を使って送信できる RequestBody を使って送信できる
BindingName Dapr バインドの名前。 ✔️ ✔️
操作 構成されたバインド操作。 ✔️ ✔️
Metadata メタデータ名前空間。 ❌ ✔️
データ 必須。 バインド操作のデータ。 ❌ ✔️

注釈

注釈 DaprBindingOutput を使用すると、出力バインドを送信する関数を作成できます。

要素 説明 Attribute を使って送信できる RequestBody を使って送信できる
bindingName Dapr バインドの名前。 ✔️ ✔️
output 構成されたバインド操作。 ✔️ ✔️
metadata メタデータ名前空間。 ❌ ✔️
data 必須。 バインド操作のデータ。 ❌ ✔️

構成

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

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
bindingName バインディングの名前。 ✔️ ✔️
operation バインド操作。 ✔️ ✔️
metadata メタデータ名前空間。 ❌ ✔️
data 必須。 バインド操作のデータ。 ❌ ✔️

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

function.json のプロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
bindingName バインディングの名前。 ✔️ ✔️
operation バインド操作。 ✔️ ✔️
metadata メタデータ名前空間。 ❌ ✔️
data 必須。 バインド操作のデータ。 ❌ ✔️

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

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
binding_name バインド イベントの名前。 ✔️ ✔️
operation バインド操作の名前または識別子。 ✔️ ✔️
metadata メタデータ名前空間。 ❌ ✔️
data 必須。 バインド操作のデータ。 ❌ ✔️

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

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

使用法

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

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

  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 サービス呼び出しの詳細。