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

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

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

以下示例演示读取单个表行的 C# 函数。 对于发送到队列的每个消息，将触发该函数。

行键值 {queueTrigger} 将行键绑定到消息元数据（即消息字符串）。

public class TableStorage
{
    public class MyPoco : 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; }
    }


    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition", "{queueTrigger}")] MyPoco poco, 
        ILogger log)
    {
        log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
    }
}

使用 TableClient 方法参数通过 Azure SDK 来读取表。 下面是一个查询 Azure Functions 日志表的函数示例：

using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Logging;
using Azure.Data.Tables;
using System;
using System.Threading.Tasks;
using Azure;
namespace FunctionAppCloudTable2
{
    public class LogEntity : ITableEntity
    {
        public string OriginalName { get; set; }

        public string PartitionKey { get; set; }
        public string RowKey { get; set; }
        public DateTimeOffset? Timestamp { get; set; }
        public ETag ETag { get; set; }
    }
    public static class CloudTableDemo
    {
        [FunctionName("CloudTableDemo")]
        public static async Task Run(
            [TimerTrigger("0 */1 * * * *")] TimerInfo myTimer,
            [Table("AzureWebJobsHostLogscommon")] TableClient tableClient,
            ILogger log)
        {
            log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");
            AsyncPageable<LogEntity> queryResults = tableClient.QueryAsync<LogEntity>(filter: $"PartitionKey eq 'FD2' and RowKey gt 't'");
            await foreach (LogEntity entity in queryResults)
            {
                log.LogInformation($"{entity.PartitionKey}\t{entity.RowKey}\t{entity.Timestamp}\t{entity.OriginalName}");
            }
        }
    }
}

有关如何使用 TableClient 的更多信息，请参阅 Azure.Data.Tables API 参考。

以下示例演示读取单个表行的 C# 函数。 对于发送到队列的每个消息，将触发该函数。

行键值 {queueTrigger} 将行键绑定到消息元数据（即消息字符串）。

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

    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition", "{queueTrigger}")] MyPoco poco, 
        ILogger log)
    {
        log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
    }
}

使用 CloudTable 方法参数通过 Azure 存储 SDK 来读取表。 下面是一个查询 Azure Functions 日志表的函数示例：

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;
using Microsoft.Azure.Cosmos.Table;
using System;
using System.Threading.Tasks;

namespace FunctionAppCloudTable2
{
    public class LogEntity : TableEntity
    {
        public string OriginalName { get; set; }
    }
    public static class CloudTableDemo
    {
        [FunctionName("CloudTableDemo")]
        public static async Task Run(
            [TimerTrigger("0 */1 * * * *")] TimerInfo myTimer, 
            [Table("AzureWebJobsHostLogscommon")] CloudTable cloudTable,
            ILogger log)
        {
            log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");

            TableQuery<LogEntity> rangeQuery = new TableQuery<LogEntity>().Where(
                TableQuery.CombineFilters(
                    TableQuery.GenerateFilterCondition("PartitionKey", QueryComparisons.Equal, 
                        "FD2"),
                    TableOperators.And,
                    TableQuery.GenerateFilterCondition("RowKey", QueryComparisons.GreaterThan, 
                        "t")));

            // Execute the query and loop through the results
            foreach (LogEntity entity in 
                await cloudTable.ExecuteQuerySegmentedAsync(rangeQuery, null))
            {
                log.LogInformation(
                    $"{entity.PartitionKey}\t{entity.RowKey}\t{entity.Timestamp}\t{entity.OriginalName}");
            }
        }
    }
}

有关如何使用 CloudTable 的详细信息，请参阅 Azure 表存储入门。

如果在尝试绑定到 CloudTable 时出现错误消息，请确保引用正确的存储 SDK 版本。

以下示例演示读取单个表行的 C# 函数。 对于发送到队列的每个消息，将触发该函数。

行键值 {queueTrigger} 将行键绑定到消息元数据（即消息字符串）。

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

    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition", "{queueTrigger}")] MyPoco poco, 
        ILogger log)
    {
        log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
    }
}

以下示例显示了一个 C# 函数，它从 MyPoco 中读取其中派生了 TableEntity 类的多个表行。

public class TableStorage
{
    public class MyPoco : TableEntity
    {
        public string Text { get; set; }
    }

    [FunctionName("TableInput")]
    public static void TableInput(
        [QueueTrigger("table-items")] string input, 
        [Table("MyTable", "MyPartition")] IQueryable<MyPoco> pocos, 
        ILogger log)
    {
        foreach (MyPoco poco in pocos)
        {
            log.LogInformation($"PK={poco.PartitionKey}, RK={poco.RowKey}, Text={poco.Text}");
        }
    }
}

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

以下函数由队列存储触发器启动，它从队列中读取行键，该键用于从输入表中获取行。 表达式 {queueTrigger} 将行键绑定到消息元数据（即消息字符串）。

[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}"
    };
}

以下由队列触发的函数将前 5 个实体作为 IEnumerable<T> 返回，分区键值设置为队列消息。

[Function("TestFunction")]
public static void Run([QueueTrigger("myqueue", Connection = "AzureWebJobsStorage")] string partition,
    [TableInput("inTable", "{queueTrigger}", Take = 5, Filter = "Text eq 'test'", 
    Connection = "AzureWebJobsStorage")] IEnumerable<MyTableData> tableInputs,
    FunctionContext context)
{
    var logger = context.GetLogger("TestFunction");
    logger.LogInformation(partition);
    foreach (MyTableData tableInput in tableInputs)
    {
        logger.LogInformation($"PK={tableInput.PartitionKey}, RK={tableInput.RowKey}, Text={tableInput.Text}");
    }
}

Filter 和 Take 属性用于限制返回的实体数。

下面的 MyTableData 类表示表中的一行数据：

        {
            var tableEntities = table.QueryAsync<TableEntity>(filter: $"RowKey eq '{rowKey}'");

            await foreach (TableEntity entity in tableEntities)
            {
                _logger.LogInformation("PK={pk}, RK={rk}, Text={t}", entity.PartitionKey, entity.RowKey, entity["Text"]);
            }

以下函数由队列存储触发器启动，它从队列中读取行键，该键用于从输入表中获取行。 表达式 {queueTrigger} 将行键绑定到消息元数据（即消息字符串）。

namespace SampleApp
{
    public class TableFunction
    {
        private readonly ILogger<TableFunction> _logger;

        public TableFunction(ILogger<TableFunction> logger)
        {
            _logger = logger;
        }

        /// <summary>
        /// This function demonstrates binding to a single <see cref="TableClient"/>
        /// and using the client for output.
        /// </summary>
        [Function(nameof(TableFunction))]
        public async Task Run(
            [QueueTrigger("table-items")] string rowKey,

以下由队列触发的函数将前 5 个实体作为 IEnumerable<T> 返回，分区键值设置为队列消息。

[Function("TestFunction")]
public static void Run([QueueTrigger("myqueue", Connection = "AzureWebJobsStorage")] string partition,
    [TableInput("inTable", "{queueTrigger}", Take = 5, Filter = "Text eq 'test'", 
    Connection = "AzureWebJobsStorage")] IEnumerable<MyTableData> tableInputs,
    FunctionContext context)
{
    var logger = context.GetLogger("TestFunction");
    logger.LogInformation(partition);
    foreach (MyTableData tableInput in tableInputs)
    {
        logger.LogInformation($"PK={tableInput.PartitionKey}, RK={tableInput.RowKey}, Text={tableInput.Text}");
    }
}

Filter 和 Take 属性用于限制返回的实体数。

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

import { app, input, InvocationContext } from '@azure/functions';

const tableInput = input.table({
    tableName: 'Person',
    partitionKey: 'Test',
    rowKey: '{queueTrigger}',
    connection: 'MyStorageConnectionAppSetting',
});

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

export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<void> {
    context.log('Node.js queue trigger function processed work item', queueItem);
    const person = <PersonEntity>context.extraInputs.get(tableInput);
    context.log('Person entity name: ' + person.Name);
}

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    extraInputs: [tableInput],
    handler: storageQueueTrigger1,
});

模型 v3 没有记录 TypeScript 示例。

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

const tableInput = input.table({
    tableName: 'Person',
    partitionKey: 'Test',
    rowKey: '{queueTrigger}',
    connection: 'MyStorageConnectionAppSetting',
});

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    extraInputs: [tableInput],
    handler: (queueItem, context) => {
        context.log('Node.js queue trigger function processed work item', queueItem);
        const person = context.extraInputs.get(tableInput);
        context.log('Person entity name: ' + person.Name);
    },
});

{
  "bindings": [
    {
      "queueName": "myqueue-items",
      "connection": "MyStorageConnectionAppSetting",
      "name": "myQueueItem",
      "type": "queueTrigger",
      "direction": "in"
    },
    {
      "name": "personEntity",
      "type": "table",
      "tableName": "Person",
      "partitionKey": "Test",
      "rowKey": "{queueTrigger}",
      "connection": "MyStorageConnectionAppSetting",
      "direction": "in"
    }
  ],
  "disabled": false
}

配置部分解释了这些属性。

JavaScript 代码如下所示：

module.exports = async function (context, myQueueItem) {
    context.log('Node.js queue trigger function processed work item', myQueueItem);
    context.log('Person entity name: ' + context.bindings.personEntity.Name);
};

import json
import azure.functions as func

app = func.FunctionApp()

@app.route(route="messages/{id}")
@app.table_input(arg_name="messageJSON",
                 connection="AzureWebJobsStorage",
                 table_name="messages",
                 row_key='{id}',
                 partition_key="message")
def table_in_binding(req: func.HttpRequest, messageJSON):
    message = json.loads(messageJSON)
    return func.HttpResponse(f"Table row: {messageJSON}")

使用这种简单绑定，无法以编程方式处理没有找到行键 ID 的行。 有关更精细的数据选择，请使用存储 SDK。

function.json 文件中的绑定配置：

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

__init__.py 文件中的 Python 代码：

import json

import azure.functions as func

def main(req: func.HttpRequest, messageJSON) -> func.HttpResponse:

    message = json.loads(messageJSON)
    return func.HttpResponse(f"Table row: {messageJSON}")

使用这种简单绑定，无法以编程方式处理没有找到行键 ID 的行。 有关更精细的数据选择，请使用存储 SDK。

在 C# 类库中，TableInputAttribute 支持以下属性：

在 C# 类库中，TableAttribute 支持以下属性：

特性的构造函数采用表名、分区键和行键，如以下示例所示：

[FunctionName("TableInput")]
public static void Run(
    [QueueTrigger("table-items")] string input, 
    [Table("MyTable", "Http", "{queueTrigger}")] MyPoco poco, 
    ILogger log)
{
    ...
}

可以设置 Connection 属性以指定与表服务的连接，如以下示例中所示：

[FunctionName("TableInput")]
public static void Run(
    [QueueTrigger("table-items")] string input, 
    [Table("MyTable", "Http", "{queueTrigger}", Connection = "StorageConnectionAppSetting")] MyPoco poco, 
    ILogger log)
{
    ...
}

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

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

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

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

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

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

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

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

若要按键返回特定实体，请使用派生自 TableEntity 的绑定参数。

若要执行可返回多个实体的查询，请绑定到 [TableClient] 对象。 然后，可以使用此对象创建和执行针对绑定表的查询。 请注意，[TableClient] 和相关 API 属于 Azure.Data.Tables 命名空间。

若要按键返回特定实体，请使用派生自 TableEntity 的绑定参数。

若要执行可返回多个实体的查询，请绑定到 CloudTable 对象。 然后，可以使用此对象创建和执行针对绑定表的查询。 请注意，CloudTable 和相关 API 属于 Microsoft.Azure.Cosmos.Table 命名空间。

若要按键返回特定实体，请使用派生自 TableEntity 的绑定参数。 特定的 TableName、PartitionKey 和 RowKey 用于尝试从表中获取特定实体。

若要执行可返回多个实体的查询，请绑定到 IQueryable<T>（其类型继承自 TableEntity）。

如果使用单个表实体，可将 Azure 表输入绑定绑到以下类型：

如果使用查询中的多个实体，可将 Azure 表输入绑定绑到以下类型：

¹ 若要使用这些类型，需要引用 Microsoft.Azure.Functions.Worker.Extensions.Tables 1.2.0 或更高版本以及 SDK 类型绑定的常见依赖项。

若要按键返回特定实体，请使用普通旧 CLR 对象 (POCO)。 特定的 TableName、PartitionKey 和 RowKey 用于尝试从表中获取特定实体。

将多个实体作为 IEnumerable<T> 返回时，可以改为使用 Take 和 Filter 属性来限制结果集。

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

使用 context.extraInputs.get() 获取输入行数据。

使用 context.bindings.<name> 获取输入行数据，其中 <name> 是在 function.jsonname 的 属性中指定的值。