Azure Event Grid bindings for Azure Functions

This reference shows how to connect to Azure Event Grid using Azure Functions triggers and bindings.

Event Grid is an Azure service that sends HTTP requests to notify you about events that happen in publishers. A publisher is the service or resource that originates the event. For example, an Azure blob storage account is a publisher, and a blob upload or deletion is an event. Some Azure services have built-in support for publishing events to Event Grid.

Event handlers receive and process events. Azure Functions is one of several Azure services that have built-in support for handling Event Grid events. Functions provides an Event Grid trigger, which invokes a function when an event is received from Event Grid. A similar output binding can be used to send events from your function to an Event Grid custom topic.

You can also use an HTTP trigger to handle Event Grid Events. To learn more, see Receive events to an HTTP endpoint. We recommend using the Event Grid trigger over HTTP trigger.

Action	Type
Run a function when an Event Grid event is dispatched	Trigger
Sends an Event Grid event	Output binding
Control the returned HTTP status code	HTTP endpoint

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 C# Azure Functions in an isolated worker process.

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 functionality of the extension varies depending on the extension version:

Extension v3.x

This version of the extension supports updated Event Grid binding parameter types of Azure.Messaging.CloudEvent and Azure.Messaging.EventGrid.EventGridEvent.

Add this version of the extension to your project by installing the NuGet package, version 3.x.

Extension v2.x

Supports the default Event Grid binding parameter type of Microsoft.Azure.EventGrid.Models.EventGridEvent. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

Add the extension to your project by installing the NuGet package, version 2.x.

Functions 1.x

Functions 1.x apps automatically have a reference to the Microsoft.Azure.WebJobs NuGet package, version 2.x. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

The Event Grid output binding is only available for Functions 2.x and higher.

Extension v3.x

Add the extension to your project by installing the NuGet package, version 3.x.

Extension v2.x

Add the extension to your project by installing the NuGet package, version 2.x. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

Functions 1.x

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

The Event Grid output binding is only available for Functions 2.x and higher.

Extension v3.x

This version of the extension supports updated Event Grid binding parameter types of Azure.Messaging.CloudEvent and Microsoft.Azure.EventGrid.Models.EventGridEvent.

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

Extension v2.x

Supports the default Event Grid binding parameter type of Microsoft.Azure.EventGrid.Models.EventGridEvent. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

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 Microsoft.Azure.WebJobs NuGet package, version 2.x. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

The Event Grid output binding is only available for Functions 2.x and higher.

Install bundle

The Event Grid extension is 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 Event Grid binding, or if bundles aren't already installed. To learn more, see extension bundle.

Bundle v3.x

You can add this version of the extension from the extension bundle v3 by adding or replacing the following configuration in your host.json file:

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.3.0, 4.0.0)"
    }
}

To learn more, see Update your extensions.

Bundle v2.x

You can install this version of the extension in your function app by registering the extension bundle, version 2.x. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

Functions 1.x

The Event Grid output binding is only available for Functions 2.x and higher. Event Grid extension versions earlier than 3.x don't support CloudEvents schema. To consume this schema, instead use an HTTP trigger.

Next steps

• If you have questions, submit an issue to the team here
• Event Grid trigger
• Event Grid output binding
• Run a function when an Event Grid event is dispatched
• Dispatch an Event Grid event