Azure Functions における Azure Functions の出力バインド

次の MyTableData のクラスは、テーブル内のデータの行を表します。

public class MyTableData : Azure.Data.Tables.ITableEntity
{
    public string Text { get; set; }

    public string PartitionKey { get; set; }
    public string RowKey { get; set; }
    public DateTimeOffset? Timestamp { get; set; }
    public ETag ETag { get; set; }
}

Queue Storage トリガーによって開始される次の関数は、 MyDataTableという名前の OutputTable に新しいエンティティを書き込みます。

[Function("TableFunction")]
[TableOutput("OutputTable", Connection = "AzureWebJobsStorage")]
public static MyTableData Run(
    [QueueTrigger("table-items")] string input,
    [TableInput("MyTable", "<PartitionKey>", "{queueTrigger}")] MyTableData tableInput,
    FunctionContext context)
{
    var logger = context.GetLogger("TableFunction");

    logger.LogInformation($"PK={tableInput.PartitionKey}, RK={tableInput.RowKey}, Text={tableInput.Text}");

    return new MyTableData()
    {
        PartitionKey = "queue",
        RowKey = Guid.NewGuid().ToString(),
        Text = $"Output record with rowkey {input} created at {DateTime.Now}"
    };
}

次の例は、HTTP トリガーを使用して 1 つのテーブル行を書き込む C# 関数を示しています。

public class TableStorage
{
    public class MyPoco
    {
        public string PartitionKey { get; set; }
        public string RowKey { get; set; }
        public string Text { get; set; }
    }

    [FunctionName("TableOutput")]
    [return: Table("MyTable")]
    public static MyPoco TableOutput([HttpTrigger] dynamic input, ILogger log)
    {
        log.LogInformation($"C# http trigger function processed: {input.Text}");
        return new MyPoco { PartitionKey = "Http", RowKey = Guid.NewGuid().ToString(), Text = input.Text };
    }
}

import { app, HttpRequest, HttpResponseInit, InvocationContext, output } from '@azure/functions';

const tableOutput = output.table({
    tableName: 'Person',
    connection: 'MyStorageConnectionAppSetting',
});

interface PersonEntity {
    PartitionKey: string;
    RowKey: string;
    Name: string;
}

export async function httpTrigger1(request: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
    const rows: PersonEntity[] = [];
    for (let i = 1; i < 10; i++) {
        rows.push({
            PartitionKey: 'Test',
            RowKey: i.toString(),
            Name: `Name ${i}`,
        });
    }
    context.extraOutputs.set(tableOutput, rows);
    return { status: 201 };
}

app.http('httpTrigger1', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [tableOutput],
    handler: httpTrigger1,
});

TypeScript のサンプルは、モデル v3 については記載されていません。

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

const tableOutput = output.table({
    tableName: 'Person',
    connection: 'MyStorageConnectionAppSetting',
});

app.http('httpTrigger1', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [tableOutput],
    handler: async (request, context) => {
        const rows = [];
        for (let i = 1; i < 10; i++) {
            rows.push({
                PartitionKey: 'Test',
                RowKey: i.toString(),
                Name: `Name ${i}`,
            });
        }
        context.extraOutputs.set(tableOutput, rows);
        return { status: 201 };
    },
});

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

{
  "bindings": [
    {
      "name": "input",
      "type": "manualTrigger",
      "direction": "in"
    },
    {
      "tableName": "Person",
      "connection": "MyStorageConnectionAppSetting",
      "name": "tableBinding",
      "type": "table",
      "direction": "out"
    }
  ],
  "disabled": false
}

これらのプロパティについては、「構成」セクションを参照してください。

JavaScript コードを次に示します。

module.exports = async function (context) {

    context.bindings.tableBinding = [];

    for (var i = 1; i < 10; i++) {
        context.bindings.tableBinding.push({
            PartitionKey: "Test",
            RowKey: i.toString(),
            Name: "Name " + i
        });
    }
};

次の関数は、rowKey 値に対して一意の UUI を生成し、メッセージを Table Storage に保持します。

import logging
import uuid
import json
import azure.functions as func

app = func.FunctionApp()

@app.route(route="table_out_binding")
@app.table_output(arg_name="message",
                  connection="AzureWebJobsStorage",
                  table_name="messages")
def table_out_binding(req: func.HttpRequest, message: func.Out[str]):
    row_key = str(uuid.uuid4())
    data = {
        "Name": "Output binding message",
        "PartitionKey": "message",
        "RowKey": row_key
    }
    table_json = json.dumps(data)
    message.set(table_json)
    return table_json

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "message",
      "type": "table",
      "tableName": "messages",
      "partitionKey": "message",
      "connection": "AzureWebJobsStorage",
      "direction": "out"
    },
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    }
  ]
}

次の関数は、rowKey 値に対して一意の UUI を生成し、メッセージを Table Storage に保持します。

import logging
import uuid
import json

import azure.functions as func

def main(req: func.HttpRequest, message: func.Out[str]) -> func.HttpResponse:

    rowKey = str(uuid.uuid4())

    data = {
        "Name": "Output binding message",
        "PartitionKey": "message",
        "RowKey": rowKey
    }

    message.set(json.dumps(data))

    return func.HttpResponse(f"Message created with the rowKey: {rowKey}")

C# クラス ライブラリでは、TableInputAttribute は次のプロパティをサポートしています。

C# クラス ライブラリでは、TableAttribute は次のプロパティをサポートしています。

この属性のコンストラクターは、テーブル名を受け取ります。 属性は、次の例のように、out パラメーターまたは関数の戻り値で使用します。

[FunctionName("TableOutput")]
[return: Table("MyTable")]
public static MyPoco TableOutput(
    [HttpTrigger] dynamic input, 
    ILogger log)
{
    ...
}

次の例に示すように、Connection プロパティを設定してテーブル サービスへの接続を指定できます。

[FunctionName("TableOutput")]
[return: Table("MyTable", Connection = "StorageConnectionAppSetting")]
public static MyPoco TableOutput(
    [HttpTrigger] dynamic input, 
    ILogger log)
{
    ...
}

属性は Connection プロパティを受け取りますが、 Connection を使用してストレージ アカウント接続を指定することもできます。 これは、ライブラリ内の他の関数とは異なるストレージ アカウントを使用する必要がある場合に実行できます。 コンストラクターは、ストレージ接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

使用するストレージ アカウントは、次の順序で決定されます。

• トリガーまたはバインド属性の Connection プロパティ。
• トリガーまたはバインド属性と同じパラメーターに適用された StorageAccount 属性。
• 関数に適用される StorageAccount 属性。
• クラスに適用される StorageAccount 属性。
• AzureWebJobsStorage アプリケーション設定で定義されている、関数アプリの既定のストレージ アカウント。

次の表では、options メソッドに渡される output.table() オブジェクトに対して設定できるプロパティについて説明します。

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

分離ワーカー プロセス クラス ライブラリでコンパイルされた C# 関数は、ランタイムから分離されたプロセスで実行されます。

インプロセス クラス ライブラリは、Functions ランタイムと同じプロセスで実行されるコンパイル済みの C# 関数です。

out パラメーターと戻り値の型では、次の型がサポートされています。

• PartitionKey のプロパティと RowKey のプロパティを含む 、単純な従来のオブジェクト (POCO)。 これらのプロパティは、ITableEntity を実装することで、付随させることができます。
• ICollector<T> または IAsyncCollector<T> には、T のプロパティと PartitionKey のプロパティが含まれています。 これらのプロパティは、ITableEntity を実装することで、付随させることができます。

Azure SDK から TableClientにバインドすることもできます。 その後、そのオブジェクトを使用してテーブルに書き込むことができます。

out パラメーターと戻り値の型では、次の型がサポートされています。

• PartitionKey のプロパティと RowKey のプロパティを含む 、単純な従来のオブジェクト (POCO)。 これらのプロパティは、ITableEntity を実装、または TableEntity を継承することで、付随させることができます。
• ICollector<T> または IAsyncCollector<T> には、T のプロパティと PartitionKey のプロパティが含まれています。 これらのプロパティは、ITableEntity を実装、または TableEntity を継承することで、付随させることができます。

メソッド パラメーターとして Storage SDK からCloudTableにバインドすることもできます。 その後、そのオブジェクトを使用してテーブルに書き込むことができます。

out パラメーターと戻り値の型では、次の型がサポートされています。

• PartitionKey のプロパティと RowKey のプロパティを含む 、単純な従来のオブジェクト (POCO)。 これらのプロパティは、ITableEntity を実装、または TableEntity を継承することで、付随させることができます。
• ICollector<T> または IAsyncCollector<T> には、T のプロパティと PartitionKey のプロパティが含まれています。 これらのプロパティは、ITableEntity を実装、または TableEntity を継承することで、付随させることができます。

メソッド パラメーターとして Storage SDK からCloudTableにバインドすることもできます。 その後、そのオブジェクトを使用してテーブルに書き込むことができます。

関数を 1 つのエンティティに書き込む場合、Azure Tables 出力バインドは次の型にバインドできます。

関数で複数のエンティティに書き込む場合、Azure テーブルの出力バインドは次の型にバインドできます。

その他の出力シナリオでは、 TableClientAzure.Data.Tables の他の型を直接作成して使用 。 依存関係の挿入を使用して Azure SDK からクライアントの種類を作成する例については Azure クライアントの登録に関するページを参照してください。

テーブル エンティティにマップできるプロパティを持つ、単純な従来の CLR オブジェクト (POCO) を返します。

Functions バージョン 1.x では、分離ワーカー プロセスはサポートされていません。

値を返すか、context.extraOutputs.set() を使って出力行データを設定します。

context.bindings.<name> を使って出力行データを設定します。この <name> は name の プロパティに指定された値です。