Durable Functions のバインド (Azure Functions)

Python v2 プログラミング モデル

Durable Functions は、新しい Python v2 プログラミング モデルでサポートされています。 v2 モデルを使用するには、PyPI パッケージ azure-functions-durable、バージョン 1.2.2 またはそれ以降のバージョンである Durable Functions SDK をインストールする必要があります。 Durable Functions で v2 モデルを使用するには、アプリが拡張機能バンドル バージョン 4.x を参照していることを host.json で確認する必要もあります。

Durable Functions SDK for Python リポジトリでフィードバックや提案を提供することができます。

.NET で関数を作成すると、OrchestrationTriggerAttribute .NET 属性を使用して、オーケストレーション トリガーが構成されます。

Java の場合、@DurableOrchestrationTrigger 注釈はオーケストレーション トリガーの構成に使用されます。

オーケストレーター関数を記述するとき、オーケストレーション トリガーは、function.json ファイルの bindings 配列の次の JSON オブジェクトによって定義されます。

{
    "name": "<Name of input parameter in function signature>",
    "orchestration": "<Optional - name of the orchestration>",
    "type": "orchestrationTrigger",
    "direction": "in"
}

• orchestration は、クライアントがこのオーケストレーター関数の新しいインスタンスを開始するときに使用する必要がある、オーケストレーションの名前です。 このプロパティは省略可能です。 指定されない場合は関数の名前が使用されます。

Azure Function では、Python の 2 つのプログラミング モデルがサポートされています。 オーケストレーション トリガーを定義する方法は、選択したプログラミング モデルによって異なります。

{
    "name": "<Name of input parameter in function signature>",
    "orchestration": "<Optional - name of the orchestration>",
    "type": "orchestrationTrigger",
    "direction": "in"
}

トリガーを定義するために使用される特定の属性は、C# 関数をインプロセスで実行しているか、分離されたワーカー プロセスで実行しているかによって異なります。

[FunctionName("HelloWorld")]
public static string Run([OrchestrationTrigger] IDurableOrchestrationContext context)
{
    string name = context.GetInput<string>();
    return $"Hello {name}!";
}

[Function("HelloWorld")]
public static string Run([OrchestrationTrigger] TaskOrchestrationContext context, string name)
{
    return $"Hello {name}!";
}

const df = require("durable-functions");

module.exports = df.orchestrator(function*(context) {
    const name = context.df.getInput();
    return `Hello ${name}!`;
});

param($Context)

$InputData = $Context.Input
$InputData

@FunctionName("HelloWorldOrchestration")
public String helloWorldOrchestration(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    return String.format("Hello %s!", ctx.getInput(String.class));
}

オーケストレーター関数の大半はアクティビティ関数を呼び出すため、"Hello World" の例でアクティビティ関数を呼び出す方法を示します。

const df = require("durable-functions");

module.exports = df.orchestrator(function*(context) {
    const name = context.df.getInput();
    const result = yield context.df.callActivity("SayHello", name);
    return result;
});

@FunctionName("HelloWorld")
public String helloWorldOrchestration(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    String input = ctx.getInput(String.class);
    String result = ctx.callActivity("SayHello", input, String.class).await();
    return result;
}

アクティビティ トリガーは ActvityTriggerAttribute .NET 属性を使用して構成されます。

アクティビティ トリガーは、@DurableActivityTrigger 注釈を使用して構成されます。

アクティビティ トリガーは、function.json の bindings 配列の次の JSON オブジェクトによって定義されます。

{
    "name": "<Name of input parameter in function signature>",
    "activity": "<Optional - name of the activity>",
    "type": "activityTrigger",
    "direction": "in"
}

• activity はアクティビティの名前です。 この値は、オーケストレーター関数がこのアクティビティ関数を呼び出すために使用する名前です。 このプロパティは省略可能です。 指定されない場合は関数の名前が使用されます。

アクティビティ トリガーを定義する方法は、選択したプログラミング モデルによって異なります。

{
    "name": "<Name of input parameter in function signature>",
    "activity": "<Optional - name of the activity>",
    "type": "activityTrigger",
    "direction": "in"
}

module.exports = async function(context) {
    return `Hello ${context.bindings.name}!`;
};

JavaScript のバインドは、追加のパラメーターとして渡すこともできるため、同じ関数を次のように単純化できます。

module.exports = async function(context, name) {
    return `Hello ${name}!`;
};

param($name)

"Hello $name!"

@FunctionName("SayHello")
public String sayHello(@DurableActivityTrigger(name = "name") String name) {
    return String.format("Hello %s!", name);
}

たとえば、アクティビティのバインディングへの入力を取得することや、Event Hubs 出力バインディングを使用してイベント ハブにメッセージを送信することができます。

{
  "bindings": [
    {
      "name": "message",
      "type": "activityTrigger",
      "direction": "in"
    },
    {
      "type": "eventHub",
      "name": "outputEventHubMessage",
      "connection": "EventhubConnectionSetting",
      "eventHubName": "eh_messages",
      "direction": "out"
  }
  ]
}

module.exports = async function (context) {
    context.bindings.outputEventHubMessage = context.bindings.message;
};

DurableClientAttribute 属性 (Durable Functions v1.x の場合は OrchestrationClientAttribute) を使用して、オーケストレーション クライアントにバインドできます。

@DurableClientInput 注釈を使用してオーケストレーション クライアントにバインドできます。

持続的クライアント トリガーは、function.json の bindings 配列の次の JSON オブジェクトによって定義されます。

{
    "name": "<Name of input parameter in function signature>",
    "taskHub": "<Optional - name of the task hub>",
    "connectionName": "<Optional - name of the connection string app setting>",
    "type": "orchestrationClient",
    "direction": "in"
}

• taskHub - 複数の関数アプリが同じストレージ アカウントを共有するが、相互に分離する必要があるシナリオで使用されます。 指定されていない場合は、host.json の既定値が使用されます。 この値は、ターゲットのオーケストレーター関数によって使用される値と一致している必要があります。
• connectionName - ストレージ アカウント接続文字列を含むアプリ設定の名前。 この接続文字列で表されるストレージ アカウントは、ターゲットのオーケストレーター関数によって使用されるものと同じにする必要があります。 指定されない場合は、関数アプリの既定のストレージ アカウント接続文字列が使用されます。

持続的クライアント トリガーを定義する方法は、選択したプログラミング モデルによって異なります。

{
    "name": "<Name of input parameter in function signature>",
    "taskHub": "<Optional - name of the task hub>",
    "connectionName": "<Optional - name of the connection string app setting>",
    "type": "orchestrationClient",
    "direction": "in"
}

通常は IDurableClient (Durable Functions v1.x の場合は DurableOrchestrationClient) にバインドします。これにより、Durable Functions によってサポートされるすべてのオーケストレーション クライアント API にフル アクセスできます。

通常は DurableClientContext クラスにバインドします 。

言語に固有の SDK を使用してクライアント オブジェクトにアクセスする必要があります。

function.json

{
  "bindings": [
    {
      "name": "input",
      "type": "queueTrigger",
      "queueName": "durable-function-trigger",
      "direction": "in"
    },
    {
      "name": "starter",
      "type": "durableClient",
      "direction": "in"
    }
  ]
}

index.js

const df = require("durable-functions");

module.exports = async function (context) {
    const client = df.getClient(context);
    return instanceId = await client.startNew("HelloWorld", undefined, context.bindings.input);
};

run.ps1

param([string] $input, $TriggerMetadata)

$InstanceId = Start-DurableOrchestration -FunctionName $FunctionName -Input $input

function.json

{
  "bindings": [
    {
      "name": "input",
      "type": "queueTrigger",
      "queueName": "durable-function-trigger",
      "direction": "in"
    },
    {
      "name": "starter",
      "type": "durableClient",
      "direction": "in"
    }
  ]
}

run.ps1

param([string]$InputData, $TriggerMetadata)

$InstanceId = Start-DurableOrchestration -FunctionName 'HelloWorld' -Input $InputData

@FunctionName("QueueStart")
public void queueStart(
        @QueueTrigger(name = "input", queueName = "durable-function-trigger", connection = "Storage") String input,
        @DurableClientInput(name = "durableContext") DurableClientContext durableContext) {
    // Orchestration input comes from the queue message content.
    durableContext.getClient().scheduleNewOrchestrationInstance("HelloWorld", input);
}

エンティティ トリガーは EntityTriggerAttribute .NET 属性を使用して構成されます。

エンティティ トリガーは、function.json の bindings 配列の次の JSON オブジェクトによって定義されます。

{
    "name": "<Name of input parameter in function signature>",
    "entityName": "<Optional - name of the entity>",
    "type": "entityTrigger",
    "direction": "in"
}

既定では、エンティティの名前は関数の名前です。

エンティティ トリガーを定義する方法は、選択したプログラミング モデルによって異なります。

{
    "name": "<Name of input parameter in function signature>",
    "entityName": "<Optional - name of the entity>",
    "type": "entityTrigger",
    "direction": "in"
}

.NET クラス ライブラリ関数の DurableClientAttribute .NET 属性を使用することで、エンティティ クライアントにバインドできます。

エンティティ クライアントは、function.json の bindings 配列の次の JSON オブジェクトによって定義されます。

{
    "name": "<Name of input parameter in function signature>",
    "taskHub": "<Optional - name of the task hub>",
    "connectionName": "<Optional - name of the connection string app setting>",
    "type": "durableClient",
    "direction": "in"
}

• taskHub - 複数の関数アプリが同じストレージ アカウントを共有するが、相互に分離する必要があるシナリオで使用されます。 指定されていない場合は、host.json の既定値が使用されます。 この値は、ターゲットのエンティティ関数によって使用される値と一致している必要があります。
• connectionName - ストレージ アカウント接続文字列を含むアプリ設定の名前。 この接続文字列で表されるストレージ アカウントは、ターゲットのエンティティ関数によって使用されるものと同じにする必要があります。 指定されない場合は、関数アプリの既定のストレージ アカウント接続文字列が使用されます。

エンティティ クライアントを定義する方法は、選択したプログラミング モデルによって異なります。

{
    "name": "<Name of input parameter in function signature>",
    "taskHub": "<Optional - name of the task hub>",
    "connectionName": "<Optional - name of the connection string app setting>",
    "type": "durableClient",
    "direction": "in"
}