次の方法で共有

Azure Functions に対する Dapr 状態出力バインド

  • [アーティクル]

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

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

例

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

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

次の例では、Dapr 状態出力バインドを使用して新しい状態を状態ストアに保持する方法を示します。

[FunctionName("StateOutputBinding")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "state/{key}")] HttpRequest req,
    [DaprState("statestore", Key = "{key}")] IAsyncCollector<string> state,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
    await state.AddAsync(requestBody);

    return new OkResult();
}

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

@FunctionName("CreateNewOrderHttpTrigger")
public String run(
        @HttpTrigger(
            name = "req",
            methods = {HttpMethod.POST},
            authLevel = AuthorizationLevel.ANONYMOUS)
            HttpRequestMessage<Optional<String>> request,
        @DaprStateOutput(
            stateStore = "%StateStoreName%",
            key = "product")
        OutputBinding<String> product,
        final ExecutionContext context) {
    context.getLogger().info("Java HTTP trigger (CreateNewOrderHttpTrigger) processed a request.");
}

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

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

app.generic('StateOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "state/{key}",
        name: "req"
    }),
    return: daprStateOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");

        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { value : payload };
    }
});

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

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

{
  "bindings": 
    {
      "type": "daprState",
      "stateStore": "%StateStoreName%",
      "direction": "out",
      "name": "order",
      "key": "order"
    }
}

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 (
    $payload
)

# C# function processed a CreateNewOrder request from the Dapr Runtime.
Write-Host "PowerShell function processed a CreateNewOrder request from the Dapr Runtime."

# Payload must be of the format { "data": { "value": "some value" } }

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $payload| ConvertTo-Json

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name order -Value $payload["data"]

次の例では、v2 Python プログラミング モデルを使用する Dapr 状態出力バインドを示します。 Python 関数アプリ コードで daprState を使用するには、次のようにします。

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpTriggerFunc")
@app.route(route="req", auth_level=dapp.auth_level.ANONYMOUS)
@app.dapr_state_output(arg_name="state", state_store="statestore", key="newOrder")
def main(req: func.HttpRequest, state: func.Out[str] ) -> str:
    # request body must be passed this way '{\"value\": { \"key\": \"some value\" } }'
    body = req.get_body()
    if body is not None:
        state.set(body.decode('utf-8'))
        logging.info(body.decode('utf-8'))
    else:
        logging.info('req body is none')
    return 'ok'

属性

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

パラメーター 説明 Attribute を使って送信できる RequestBody を使って送信できる
StateStore 状態を保存する状態ストアの名前。 ✔️ ❌
キー 状態ストア内で状態を保存するキーの名前。 ✔️ ✔️
Value 必須。 保存される値。 ❌ ✔️

注釈

DaprStateOutput 注釈を使うと、関数で状態ストアにアクセスできるようになります。

要素 説明 Attribute を使って送信できる RequestBody を使って送信できる
stateStore 状態を保存する状態ストアの名前。 ✔️ ❌
key 状態ストア内で状態を保存するキーの名前。 ✔️ ✔️
value 必須。 保存される値。 ❌ ✔️

構成

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

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
stateStore 状態を保存する状態ストアの名前。 ✔️ ❌
key 状態ストア内で状態を保存するキーの名前。 ✔️ ✔️
value 必須。 保存される値。 ❌ ✔️

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

function.json のプロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
stateStore 状態を保存する状態ストアの名前。 ✔️ ❌
key 状態ストア内で状態を保存するキーの名前。 ✔️ ✔️
value 必須。 保存される値。 ❌ ✔️

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

プロパティ 説明 Attribute を使って送信できる RequestBody を使って送信できる
stateStore 状態を保存する状態ストアの名前。 ✔️ ❌
key 状態ストア内で状態を保存するキーの名前。 ✔️ ✔️
value 必須。 保存される値。 ❌ ✔️

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

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

使用法

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

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

  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 の状態管理の詳細を理解する。