Azure Functions 的 Azure 表存储输入绑定Azure Table storage input bindings for Azure Functions

一个实体One entity

以下示例演示读取单个表行的 C# 函数。The following example shows a C# function that reads a single table row. 对于发送到队列的每个消息，将触发该函数。For every message sent to the queue, the function will be triggered.

行键值“{queueTrigger}”指示行键来自队列消息字符串。The row key value "{queueTrigger}" indicates that the row key comes from the queue message string.

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

CloudTableCloudTable

CloudTable 仅在 Functions v2 及更高版本的运行时中受支持。CloudTable is only supported in the Functions v2 and and higher runtimes.

使用 CloudTable 方法参数通过 Azure 存储 SDK 来读取表。Use a CloudTable method parameter to read the table by using the Azure Storage SDK. 下面是一个查询 Azure Functions 日志表的函数示例：Here's an example of a function that queries an Azure Functions log table:

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 表存储入门。For more information about how to use CloudTable, see Get started with Azure Table storage.

如果在尝试绑定到 CloudTable 时出现错误消息，请确保引用正确的存储 SDK 版本。If you try to bind to CloudTable and get an error message, make sure that you have a reference to the correct Storage SDK version.

IQueryableIQueryable

IQueryable 仅在 Functions v1 运行时中受支持。IQueryable is only supported in the Functions v1 runtime.

以下示例显示了一个 C# 函数，它从 TableEntity 中读取其中派生了 MyPoco 类的多个表行。The following example shows a C# function that reads multiple table rows where the MyPoco class derives from 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}");
        }
    }
}

一个实体One entity

以下示例演示 function.json 文件中的一个表输入绑定以及使用该绑定的 C# 脚本代码。The following example shows a table input binding in a function.json file and C# script code that uses the binding. 该函数使用队列触发器来读取单个表行。The function uses a queue trigger to read a single table row.

function.json 文件指定 partitionKey 和 rowKey。The function.json file specifies a partitionKey and a rowKey. rowKey 值“{queueTrigger}”指示行键来自队列消息字符串。The rowKey value "{queueTrigger}" indicates that the row key comes from the queue message string.

{
  "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
}

配置部分解释了这些属性。The configuration section explains these properties.

C# 脚本代码如下所示：Here's the C# script code:

public static void Run(string myQueueItem, Person personEntity, ILogger log)
{
    log.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
    log.LogInformation($"Name in Person entity: {personEntity.Name}");
}

public class Person
{
    public string PartitionKey { get; set; }
    public string RowKey { get; set; }
    public string Name { get; set; }
}

CloudTableCloudTable

IQueryable 在版本 2.x 及更高版本的 Functions 运行时中不受支持。IQueryable isn't supported in the Functions runtime for versions 2.x and higher). 一种替代方法是使用 CloudTable 方法参数通过 Azure 存储 SDK 来读取表。An alternative is to use a CloudTable method parameter to read the table by using the Azure Storage SDK. 下面是一个查询 Azure Functions 日志表的函数示例：Here's an example of a function that queries an Azure Functions log table:

{
  "bindings": [
    {
      "name": "myTimer",
      "type": "timerTrigger",
      "direction": "in",
      "schedule": "0 */1 * * * *"
    },
    {
      "name": "cloudTable",
      "type": "table",
      "connection": "AzureWebJobsStorage",
      "tableName": "AzureWebJobsHostLogscommon",
      "direction": "in"
    }
  ],
  "disabled": false
}

#r "Microsoft.WindowsAzure.Storage"
using Microsoft.WindowsAzure.Storage.Table;
using System;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;

public static async Task Run(TimerInfo myTimer, 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, 
            "a")));

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

public class LogEntity : TableEntity
{
    public string OriginalName { get; set; }
}

有关如何使用 CloudTable 的详细信息，请参阅 Azure 表存储入门。For more information about how to use CloudTable, see Get started with Azure Table storage.

如果在尝试绑定到 CloudTable 时出现错误消息，请确保引用正确的存储 SDK 版本。If you try to bind to CloudTable and get an error message, make sure that you have a reference to the correct Storage SDK version.

IQueryableIQueryable

以下示例演示 function.json 文件中的一个表输入绑定以及使用该绑定的 C# 脚本代码。The following example shows a table input binding in a function.json file and C# script code that uses the binding. 该函数读取队列消息中指定的分区键的实体。The function reads entities for a partition key that is specified in a queue message.

function.json 文件如下所示：Here's the function.json file:

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

配置部分解释了这些属性。The configuration section explains these properties.

C# 脚本代码添加对 Azure 存储 SDK 的引用，以便实体类型可以从 TableEntity 派生。The C# script code adds a reference to the Azure Storage SDK so that the entity type can derive from TableEntity:

#r "Microsoft.WindowsAzure.Storage"
using Microsoft.WindowsAzure.Storage.Table;
using Microsoft.Extensions.Logging;

public static void Run(string myQueueItem, IQueryable<Person> tableBinding, ILogger log)
{
    log.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
    foreach (Person person in tableBinding.Where(p => p.PartitionKey == myQueueItem).ToList())
    {
        log.LogInformation($"Name: {person.Name}");
    }
}

public class Person : TableEntity
{
    public string Name { get; set; }
}

以下示例显示了一个 HTTP 触发函数，该函数返回表存储中指定分区中的 person 对象列表。The following example shows an HTTP triggered function which returns a list of person objects who are in a specified partition in Table storage. 在此示例中，分区键将从 http 路由中提取，表名和连接将从函数设置中提取。In the example, the partition key is extracted from the http route, and the tableName and connection are from the function settings.

public class Person {
    private String PartitionKey;
    private String RowKey;
    private String Name;

    public String getPartitionKey() { return this.PartitionKey; }
    public void setPartitionKey(String key) { this.PartitionKey = key; }
    public String getRowKey() { return this.RowKey; }
    public void setRowKey(String key) { this.RowKey = key; }
    public String getName() { return this.Name; }
    public void setName(String name) { this.Name = name; }
}

@FunctionName("getPersonsByPartitionKey")
public Person[] get(
        @HttpTrigger(name = "getPersons", methods = {HttpMethod.GET}, authLevel = AuthorizationLevel.FUNCTION, route="persons/{partitionKey}") HttpRequestMessage<Optional<String>> request,
        @BindingName("partitionKey") String partitionKey,
        @TableInput(name="persons", partitionKey="{partitionKey}", tableName="%MyTableName%", connection="MyConnectionString") Person[] persons,
        final ExecutionContext context) {

    context.getLogger().info("Got query for person related to persons with partition key: " + partitionKey);

    return persons;
}

TableInput 注释还可以从请求的 json 正文中提取绑定，如下面的示例所示。The TableInput annotation can also extract the bindings from the json body of the request, like the following example shows.

@FunctionName("GetPersonsByKeysFromRequest")
public HttpResponseMessage get(
        @HttpTrigger(name = "getPerson", methods = {HttpMethod.GET}, authLevel = AuthorizationLevel.FUNCTION, route="query") HttpRequestMessage<Optional<String>> request,
        @TableInput(name="persons", partitionKey="{partitionKey}", rowKey = "{rowKey}", tableName="%MyTableName%", connection="MyConnectionString") Person person,
        final ExecutionContext context) {

    if (person == null) {
        return request.createResponseBuilder(HttpStatus.NOT_FOUND)
                    .body("Person not found.")
                    .build();
    }

    return request.createResponseBuilder(HttpStatus.OK)
                    .header("Content-Type", "application/json")
                    .body(person)
                    .build();
}

下面的示例使用 Filter 在 Azure 表中查询具有特定名称的人员，并将可能的匹配项数目限制为 10 个结果。The following example uses the Filter to query for persons with a specific name in an Azure Table, and limits the number of possible matches to 10 results.

@FunctionName("getPersonsByName")
public Person[] get(
        @HttpTrigger(name = "getPersons", methods = {HttpMethod.GET}, authLevel = AuthorizationLevel.FUNCTION, route="filter/{name}") HttpRequestMessage<Optional<String>> request,
        @BindingName("name") String name,
        @TableInput(name="persons", filter="Name eq '{name}'", take = "10", tableName="%MyTableName%", connection="MyConnectionString") Person[] persons,
        final ExecutionContext context) {

    context.getLogger().info("Got query for person related to persons with name: " + name);

    return persons;
}

以下示例演示 function.json 文件中的一个表输入绑定以及使用该绑定的 JavaScript 脚本代码。The following example shows a table input binding in a function.json file and JavaScript code that uses the binding. 该函数使用队列触发器来读取单个表行。The function uses a queue trigger to read a single table row.

function.json 文件指定 partitionKey 和 rowKey。The function.json file specifies a partitionKey and a rowKey. rowKey 值“{queueTrigger}”指示行键来自队列消息字符串。The rowKey value "{queueTrigger}" indicates that the row key comes from the queue message string.

{
  "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
}

配置部分解释了这些属性。The configuration section explains these properties.

JavaScript 代码如下所示：Here's the JavaScript code:

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

下面的函数使用队列触发器读取单个表行作为函数的输入。The following function uses a queue trigger to read a single table row as input to a function.

在此示例中，绑定配置为表的 partitionKey 指定一个显式值，并使用了一个要传递给 rowKey 的表达式。In this example, the binding configuration specifies an explicit value for the table's partitionKey and uses an expression to pass to the rowKey. rowKey 表达式 {queueTrigger} 指示行键来自队列消息字符串。The rowKey expression, {queueTrigger}, indicates that the row key comes from the queue message string.

function.json 中的绑定配置：Binding configuration in function.json:

{
  "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
}

run.ps1 中的 PowerShell 代码：PowerShell code in run.ps1:

param($MyQueueItem, $PersonEntity, $TriggerMetadata)
Write-Host "PowerShell queue trigger function processed work item: $MyQueueItem"
Write-Host "Person entity name: $($PersonEntity.Name)"

在 C# 类库中，请使用以下属性来配置表输入绑定：In C# class libraries, use the following attributes to configure a table input binding:

• TableAttributeTableAttribute

  该特性的构造函数采用表名称、分区键和行键。The attribute's constructor takes the table name, partition key, and row key. 可对函数的 out 参数或返回值使用该特性，如以下示例中所示：The attribute can be used on an out parameter or on the return value of the function, as shown in the following example:

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

  可以设置 Connection 属性来指定要使用的存储帐户，如以下示例中所示：You can set the Connection property to specify the storage account to use, as shown in the following example:

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

  有关完整示例，请参阅 C# 示例。For a complete example, see the C# example.

• StorageAccountAttributeStorageAccountAttribute

  提供另一种方式来指定要使用的存储帐户。Provides another way to specify the storage account to use. 构造函数采用包含存储连接字符串的应用设置的名称。The constructor takes the name of an app setting that contains a storage connection string. 可以在参数、方法或类级别应用该特性。The attribute can be applied at the parameter, method, or class level. 以下示例演示类级别和方法级别：The following example shows class level and method level:

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

要使用的存储帐户按以下顺序确定：The storage account to use is determined in the following order:

• Table 特性的 Connection 属性。The Table attribute's Connection property.
• 作为 Table 特性应用到同一参数的 StorageAccount 特性。The StorageAccount attribute applied to the same parameter as the Table attribute.
• 应用到函数的 StorageAccount 特性。The StorageAccount attribute applied to the function.
• 应用到类的 StorageAccount 特性。The StorageAccount attribute applied to the class.
• 函数应用的默认存储帐户（“AzureWebJobsStorage”应用设置）。The default storage account for the function app ("AzureWebJobsStorage" app setting).

C# 脚本不支持特性。Attributes are not supported by C# Script.

在 Java 函数运行时库中，对其值将来自表存储的参数使用 @TableInput 注释。In the Java functions runtime library, use the @TableInput annotation on parameters whose value would come from Table storage. 可以将此注释与本机 Java 类型、POJO 或使用了 Optional<T> 的可为 null 的值一起使用。This annotation can be used with native Java types, POJOs, or nullable values using Optional<T>.

JavaScript 不支持特性。Attributes are not supported by JavaScript.

PowerShell 不支持特性。Attributes are not supported by PowerShell.

• 读取一行Read one row in

  设置 partitionKey 和 rowKey。Set partitionKey and rowKey. 使用方法参数 T <paramName> 访问表数据。Access the table data by using a method parameter T <paramName>. 在 C# 脚本中，paramName 是在 function.json 的 name 属性中指定的值。In C# script, paramName is the value specified in the name property of function.json. T 通常是实现 ITableEntity 或派生自 TableEntity 的类型。T is typically a type that implements ITableEntity or derives from TableEntity. 此方案中不使用 filter 和 take 属性。The filter and take properties are not used in this scenario.

• 读取一行或多行Read one or more rows

  使用方法参数 IQueryable<T> <paramName> 访问表数据。Access the table data by using a method parameter IQueryable<T> <paramName>. 在 C# 脚本中，paramName 是在 function.json 的 name 属性中指定的值。In C# script, paramName is the value specified in the name property of function.json. T 必须是实现 ITableEntity 或派生自 TableEntity 的类型。T must be a type that implements ITableEntity or derives from TableEntity. 可以使用 IQueryable 方法执行任何所需的筛选。You can use IQueryable methods to do any filtering required. 此方案中不使用 partitionKey、rowKey、filter 和 take 属性。The partitionKey, rowKey, filter, and take properties are not used in this scenario.

  备注

  Functions v2 运行时不支持 IQueryable。IQueryable isn't supported in the Functions v2 runtime. 一种替代方法是使用 CloudTable paramName 方法参数通过 Azure 存储 SDK 来读取表。An alternative is to use a CloudTable paramName method parameter to read the table by using the Azure Storage SDK. 如果在尝试绑定到 CloudTable 时出现错误消息，请确保引用正确的存储 SDK 版本。If you try to bind to CloudTable and get an error message, make sure that you have a reference to the correct Storage SDK version.

• 读取一行Read one row in

  设置 partitionKey 和 rowKey。Set partitionKey and rowKey. 使用方法参数 T <paramName> 访问表数据。Access the table data by using a method parameter T <paramName>. 在 C# 脚本中，paramName 是在 function.json 的 name 属性中指定的值。In C# script, paramName is the value specified in the name property of function.json. T 通常是实现 ITableEntity 或派生自 TableEntity 的类型。T is typically a type that implements ITableEntity or derives from TableEntity. 此方案中不使用 filter 和 take 属性。The filter and take properties are not used in this scenario.

• 读取一行或多行Read one or more rows

  使用方法参数 IQueryable<T> <paramName> 访问表数据。Access the table data by using a method parameter IQueryable<T> <paramName>. 在 C# 脚本中，paramName 是在 function.json 的 name 属性中指定的值。In C# script, paramName is the value specified in the name property of function.json. T 必须是实现 ITableEntity 或派生自 TableEntity 的类型。T must be a type that implements ITableEntity or derives from TableEntity. 可以使用 IQueryable 方法执行任何所需的筛选。You can use IQueryable methods to do any filtering required. 此方案中不使用 partitionKey、rowKey、filter 和 take 属性。The partitionKey, rowKey, filter, and take properties are not used in this scenario.

  备注

  Functions v2 运行时不支持 IQueryable。IQueryable isn't supported in the Functions v2 runtime. 一种替代方法是使用 CloudTable paramName 方法参数通过 Azure 存储 SDK 来读取表。An alternative is to use a CloudTable paramName method parameter to read the table by using the Azure Storage SDK. 如果在尝试绑定到 CloudTable 时出现错误消息，请确保引用正确的存储 SDK 版本。If you try to bind to CloudTable and get an error message, make sure that you have a reference to the correct Storage SDK version.

使用 TableInput 特性可以访问触发了函数的表行。The TableInput attribute gives you access to the table row that triggered the function.

设置 filter 和 take 属性。Set the filter and take properties. 不要设置 partitionKey 或 rowKey。Don't set partitionKey or rowKey. 使用 context.bindings.<BINDING_NAME> 访问输入一个或多个输入表实体。Access the input table entity (or entities) using context.bindings.<BINDING_NAME>. 反序列化的对象具有 RowKey 和 PartitionKey 属性。The deserialized objects have RowKey and PartitionKey properties.

数据将传递给 function.json 文件中 name 键所指定的输入参数。Data is passed to the input parameter as specified by the name key in the function.json file. 通过指定 partitionKey 和 rowKey，可以筛选到特定记录。Specifying The partitionKey and rowKey allows you to filter to specific records. 有关更多详细信息，请参阅 PowerShell 示例。See the PowerShell example for more detail.