TableInput Interface

Package:

com.microsoft.azure.functions.annotation

public interface TableInput

TableInput(name = "items", tableName = "mytablename", partitionKey = "myparkey", connection = "myconnvarname") MyItem[] items ) { return items.length; }

Method Summary

Modifier and Type	Method and Description
String	connection() Defines the app setting name that contains the Azure Storage connection string.
String	dataType() Defines how Functions runtime should treat the parameter value. Possible values are: <li> <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p> </li> <li> <p>string: always get the value as a string </p> </li> <li> <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p> </li>
String	filter() Defines the filter of the storage table to which to bind.
String	name() The variable name used in function.json.
String	partitionKey() Defines the partition key of the storage table to which to bind.
String	rowKey() Defines the row key of the storage table to which to bind.
String	tableName() Defines the name of the storage table to which to bind.
String	take() Defines the number of rows to be retrieved from the storage table to which to bind.

Method Details

connection

public String connection() default ""

Defines the app setting name that contains the Azure Storage connection string.

Returns:

The app setting name of the connection string.

dataType

public String dataType() default ""

Defines how Functions runtime should treat the parameter value. Possible values are:

<li>

  <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p>

</li>

<li>

  <p>string: always get the value as a string </p>

</li>

<li>

  <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p>

</li>

Returns:

The dataType which will be used by the Functions runtime.

filter

public String filter() default ""

Defines the filter of the storage table to which to bind.

Returns:

The storage table filter string.

name

public String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

partitionKey

public String partitionKey() default ""

Defines the partition key of the storage table to which to bind.

Returns:

The storage table partition key string.

rowKey

public String rowKey() default ""

Defines the row key of the storage table to which to bind.

Returns:

The storage table row key string.

tableName

public String tableName()

Defines the name of the storage table to which to bind.

Returns:

The storage table name string.

take

public String take() default ""

Defines the number of rows to be retrieved from the storage table to which to bind.

Returns:

The storage table retrieving rows number string.