适用于 Azure Functions 的 Azure 表存储输出绑定Azure Table storage output bindings for Azure Functions

以下示例演示使用 HTTP 触发器写入单个表行的 C# 函数。The following example shows a C# function that uses an HTTP trigger to write a single table row.

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

以下示例演示 function.json 文件中的一个表输出绑定以及使用该绑定的 C# 脚本代码。The following example shows a table output binding in a function.json file and C# script code that uses the binding. 该函数写入多个表实体。The function writes multiple table entities.

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

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

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

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

public static void Run(string input, ICollector<Person> tableBinding, ILogger log)
{
    for (int i = 1; i < 10; i++)
        {
            log.LogInformation($"Adding Person entity {i}");
            tableBinding.Add(
                new Person() { 
                    PartitionKey = "Test", 
                    RowKey = i.ToString(), 
                    Name = "Name" + i.ToString() }
                );
        }

}

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

以下示例演示了使用 HTTP 触发器写入单个表行的 Java 函数。The following example shows a Java function that uses an HTTP trigger to write a single table row.

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

public class AddPerson {

    @FunctionName("addPerson")
    public HttpResponseMessage get(
            @HttpTrigger(name = "postPerson", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.FUNCTION, route="persons/{partitionKey}/{rowKey}") HttpRequestMessage<Optional<Person>> request,
            @BindingName("partitionKey") String partitionKey,
            @BindingName("rowKey") String rowKey,
            @TableOutput(name="person", partitionKey="{partitionKey}", rowKey = "{rowKey}", tableName="%MyTableName%", connection="MyConnectionString") OutputBinding<Person> person,
            final ExecutionContext context) {

        Person outPerson = new Person();
        outPerson.setPartitionKey(partitionKey);
        outPerson.setRowKey(rowKey);
        outPerson.setName(request.getBody().get().getName());

        person.setValue(outPerson);

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

以下示例演示了使用 HTTP 触发器写入多个表行的 Java 函数。The following example shows a Java function that uses an HTTP trigger to write multiple table rows.

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

public class AddPersons {

    @FunctionName("addPersons")
    public HttpResponseMessage get(
            @HttpTrigger(name = "postPersons", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.FUNCTION, route="persons/") HttpRequestMessage<Optional<Person[]>> request,
            @TableOutput(name="person", tableName="%MyTableName%", connection="MyConnectionString") OutputBinding<Person[]> persons,
            final ExecutionContext context) {

        persons.setValue(request.getBody().get());

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

以下示例演示 function.json 文件中的一个表输出绑定以及使用该绑定的 JavaScript 函数。The following example shows a table output binding in a function.json file and a JavaScript function that uses the binding. 该函数写入多个表实体。The function writes multiple table entities.

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

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

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

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

module.exports = function (context) {

    context.bindings.tableBinding = [];

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

    context.done();
};

以下示例演示如何通过一个函数向表中写入多个实体。The following example demonstrates how to write multiple entities to a table from a function.

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

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

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

param($InputData, $TriggerMetadata)
  
foreach ($i in 1..10) {
    Push-OutputBinding -Name TableBinding -Value @{
        PartitionKey = 'Test'
        RowKey = "$i"
        Name = "Name $i"
    }
}

在 C# 类库中，使用 TableAttribute。In C# class libraries, use the TableAttribute.

该特性的构造函数采用表名称。The attribute's constructor takes the table name. 可对函数的 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("TableOutput")]
[return: Table("MyTable")]
public static MyPoco TableOutput(
    [HttpTrigger] dynamic input, 
    ILogger log)
{
    ...
}

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

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

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

可以使用 StorageAccount 特性在类、方法或参数级别指定存储帐户。You can use the StorageAccount attribute to specify the storage account at class, method, or parameter level. 有关详细信息，请参阅输入 - 特性。For more information, see Input - attributes.

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

在 Java 函数运行时库中，对参数使用 TableOutput 注释以将值写入到表存储中。In the Java functions runtime library, use the TableOutput annotation on parameters to write values into table storage.

请参阅示例来了解更多详细信息。See the example for more detail.

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

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

可以使用方法参数 ICollector<T> paramName 或 IAsyncCollector<T> paramName 访问输出表实体，其中 T 包括 PartitionKey 和 RowKey 属性。Access the output table entity by using a method parameter ICollector<T> paramName or IAsyncCollector<T> paramName where T includes the PartitionKey and RowKey properties. 实现 ITableEntity 或继承 TableEntity 时通常会伴随使用这些属性。These properties are often accompanied by implementing ITableEntity or inheriting TableEntity.

另外，还可以使用 CloudTable 方法参数通过 Azure 存储 SDK 来写入到表。Alternatively you can use a CloudTable method parameter to write to 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.

可以使用方法参数 ICollector<T> paramName 或 IAsyncCollector<T> paramName 访问输出表实体，其中 T 包括 PartitionKey 和 RowKey 属性。Access the output table entity by using a method parameter ICollector<T> paramName or IAsyncCollector<T> paramName where T includes the PartitionKey and RowKey properties. 实现 ITableEntity 或继承 TableEntity 时通常会伴随使用这些属性。These properties are often accompanied by implementing ITableEntity or inheriting TableEntity. paramName 值是在 function.json 的 name 属性中指定的。The paramName value is specified in the name property of function.json.

另外，还可以使用 CloudTable 方法参数通过 Azure 存储 SDK 来写入到表。Alternatively you can use a CloudTable method parameter to write to 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.

有两个选项可用于使用 TableStorageOutput 注释从函数来输出表存储行：There are two options for outputting a Table storage row from a function by using the TableStorageOutput annotation:

• 返回值：通过将注释应用于函数本身，函数的返回值将持久保存为表存储行。Return value: By applying the annotation to the function itself, the return value of the function is persisted as a Table storage row.

• 命令性：若要显式设置消息值，请将注释应用于 OutputBinding<T> 类型的特定参数，其中 T 包括 PartitionKey 和 RowKey 属性。Imperative: To explicitly set the message value, apply the annotation to a specific parameter of the type OutputBinding<T>, where T includes the PartitionKey and RowKey properties. 实现 ITableEntity 或继承 TableEntity 时通常会伴随使用这些属性。These properties are often accompanied by implementing ITableEntity or inheriting TableEntity.

使用 context.bindings.<name> 访问输出事件，其中 <name> 是在 function.json 的 name 属性中指定的值。Access the output event by using context.bindings.<name> where <name> is the value specified in the name property of function.json.

若要写入到表数据，请使用 Push-OutputBinding cmdlet，将 -Name TableBinding 参数和 -Value 参数设置为等于行数据。To write to table data, use the Push-OutputBinding cmdlet, set the -Name TableBinding parameter and -Value parameter equal to the row data. 有关更多详细信息，请参阅 PowerShell 示例。See the PowerShell example for more detail.