Azure Tables bindings for Azure Functions

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Azure Functions integrates with Azure Tables via triggers and bindings. Integrating with Azure Tables allows you to build functions that read and write data using the Tables API for Azure Storage and Cosmos DB.

Note

The Table bindings have historically only supported Azure Storage. Support for Cosmos DB is currently in preview. See Table API extension (preview).

Action	Type
Read table data in a function	Input binding
Allow a function to write table data	Output binding

Install extension

The extension NuGet package you install depends on the C# mode you're using in your function app:

In-process

Functions execute in the same process as the Functions host. To learn more, see Develop C# class library functions using Azure Functions.

Isolated process

Functions execute in an isolated C# worker process. To learn more, see Guide for running functions on .NET 5.0 in Azure.

C# script

Functions run as C# script, which is supported primarily for C# portal editing. To update existing binding extensions for C# script apps running in the portal without having to republish your function app, see Update your extensions.

The process for installing the extension varies depending on the extension version:

Table API extension

This version introduces the ability to connect using an identity instead of a secret. For a tutorial on configuring your function apps with managed identities, see the creating a function app with identity-based connections tutorial.

This version allows you to bind to types from Azure.Data.Tables. It also introduces the ability to use Cosmos DB Table APIs.

This extension is available by installing the Microsoft.Azure.WebJobs.Extensions.Tables NuGet package into a project using version 5.x or higher of the extensions for blobs and queues.

Using the .NET CLI:

# Install the Tables API extension
dotnet add package Microsoft.Azure.WebJobs.Extensions.Tables --version 1.0.0

# Update the combined Azure Storage extension (to a version which no longer includes Tables)
dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage --version 5.0.0

Note

Blob Storage, Queue Storage, and Table Storage now use separate extensions and are referenced individually. For example, to use the triggers and bindings for all three services in your .NET in-process app, you should add the following packages to your project:

• Microsoft.Azure.WebJobs.Extensions.Storage.Blobs
• Microsoft.Azure.WebJobs.Extensions.Storage.Queues
• Microsoft.Azure.WebJobs.Extensions.Tables

Previously, the extensions shipped together as Microsoft.Azure.WebJobs.Extensions.Storage, version 4.x. This same package also has a 5.x version, which references the split packages for blobs and queues only. When upgrading your package references from older versions, you may therefore need to additionally reference the new Microsoft.Azure.WebJobs.Extensions.Tables NuGet package. Also, when referencing these newer split packages, make sure you are not referencing an older version of the combined storage package, as this will result in conflicts from two definitions of the same bindings.

Combined Azure Storage extension

Working with the bindings requires that you reference the appropriate NuGet package. Tables are included in a combined package for Azure Storage. Install the Microsoft.Azure.WebJobs.Extensions.Storage NuGet package, version 3.x or 4.x.

Note

Tables have been moved out of this package starting in its 5.x version. You need to instead use version 4.x of the extension NuGet package or additionally include the Table API extension when using version 5.x.

Functions 1.x

Functions 1.x apps automatically have a reference the Microsoft.Azure.WebJobs NuGet package, version 2.x.

In Functions 1.x, the Storage triggers and bindings use version 7.2.1 of the Azure Storage SDK (WindowsAzure.Storage NuGet package). If you reference a different version of the Storage SDK, and you bind to a Storage SDK type in your function signature, the Functions runtime may report that it can't bind to that type. The solution is to make sure your project references WindowsAzure.Storage 7.2.1.

Combined Azure Storage extension

Tables are included in a combined package for Azure Storage. Install the Microsoft.Azure.Functions.Worker.Extensions.Storage NuGet package, version 4.x.

Note

Tables have been moved out of this package starting in its 5.x version. You need to instead use version 4.x.

Table API extension (preview)

The Table API extension does not currently support isolated process. You will instead need to use the Storage extension.

Functions 1.x

Functions version 1.x doesn't support isolated process.

Combined Azure Storage extension

You can install this version of the extension in your function app by registering the extension bundle, version 2.x.

Note

Version 3.x of the extension bundle doesn't include the Table Storage bindings. You need to instead use version 2.x for now.

Table API extension (preview)

Version 3.x of the extension bundle doesn't currently include the Table API bindings. For now, you need to instead use version 2.x of the extension bundle, which uses the Storage extension.

Functions 1.x

Functions 1.x apps automatically have a reference to the Microsoft.Azure.WebJobs NuGet package, version 2.x.

Install bundle

The Azure Tables bindings are part of an extension bundle, which is specified in your host.json project file. You may need to modify this bundle to change the version of the bindings, or if bundles aren't already installed. To learn more, see extension bundle.

Bundle v3.x

Version 3.x of the extension bundle doesn't currently include the Azure Tables bindings. You need to instead use version 2.x of the extension bundle.

Bundle v2.x

You can install this version of the extension in your function app by registering the extension bundle, version 2.x.

Functions 1.x

Functions 1.x apps automatically have a reference to the extension.

Next steps

• Read table data when a function runs
• Write table data from a function