适用于 Azure Functions 的 Azure 表输出绑定

下面的 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; }
}

以下函数由队列存储触发器启动，可将新 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 触发器写入单个表行的 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 { HttpRequest, HttpResponseInit, InvocationContext, app, 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,
});

模型 v3 没有记录 TypeScript 示例。

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
        });
    }
};

在 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 属性，但你也可以使用 StorageAccountAttribute 来指定存储帐户连接。 如果需要使用一个不同于库中的其他函数的存储帐户，可以执行此操作。 构造函数采用包含存储连接字符串的应用设置的名称。 可以在参数、方法或类级别应用该特性。 以下示例演示类级别和方法级别：

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

要使用的存储帐户按以下顺序确定：

• 触发器或绑定特性的 Connection 属性。
• 作为触发器或绑定特性应用到同一参数的 StorageAccount 特性。
• 应用到函数的 StorageAccount 特性。
• 应用到类的 StorageAccount 特性。
• 函数应用的默认存储帐户，在 AzureWebJobsStorage 应用程序设置中定义。

下表说明了可以在传递给 output.table() 方法的 options 对象上设置的属性。

下表解释了在 function.json 文件中设置的绑定配置属性。

独立工作进程类库的已编译 C# 函数在独立于运行时的进程中运行。

进程内类库是编译的 C# 函数，该函数在与 Functions 运行时相同的进程中运行。

out 参数和返回类型支持以下类型：

• 包含 PartitionKey 和 RowKey 属性的普通旧 CLR 对象 (POCO)。 可以通过实现 ITableEntity 来随附这些属性。
• ICollector<T> 或 IAsyncCollector<T>，其中 T 包括 PartitionKey 和 RowKey 属性。 可以通过实现 ITableEntity 来随附这些属性。

还可以从 Azure SDK 绑定到 TableClient。 然后，可以使用该对象写入到表。

out 参数和返回类型支持以下类型：

• 包含 PartitionKey 和 RowKey 属性的普通旧 CLR 对象 (POCO)。 可以通过实现 ITableEntity 或继承 TableEntity 来随附这些属性。
• ICollector<T> 或 IAsyncCollector<T>，其中 T 包括 PartitionKey 和 RowKey 属性。 可以通过实现 ITableEntity 或继承 TableEntity 来随附这些属性。

还可以作为方法参数从存储 SDK 绑定到 CloudTable。 然后，可以使用该对象写入到表。

out 参数和返回类型支持以下类型：

• 包含 PartitionKey 和 RowKey 属性的普通旧 CLR 对象 (POCO)。 可以通过实现 ITableEntity 或继承 TableEntity 来随附这些属性。
• ICollector<T> 或 IAsyncCollector<T>，其中 T 包括 PartitionKey 和 RowKey 属性。 可以通过实现 ITableEntity 或继承 TableEntity 来随附这些属性。

还可以作为方法参数从存储 SDK 绑定到 CloudTable。 然后，可以使用该对象写入到表。

如果希望函数写入单个实体，Azure 表输出绑定可以绑定到以下类型：

如果希望函数写入多个实体，Azure 表输出绑定可以绑定到以下类型：

对于其他输出方案，请直接创建和使用 Azure.Data.Tables 中的类型。

使用可映射到表实体的属性返回普通旧 CLR 对象 (POCO)。

Functions 版本 1.x 不支持独立工作进程。

通过返回值或使用 context.extraOutputs.set() 设置输出行数据。

使用 context.bindings.<name> 设置输出行数据，其中 <name> 是在 function.json 的 name 属性中指定的值。