Get started with the Azure Functions integration

Choose a development environment

Visual Studio Code Visual Studio .NET CLI

Azure Functions is a serverless compute service that lets you run event-triggered code without having to explicitly provision or manage infrastructure. The Aspire Azure Functions integration enables you to model Azure Functions projects as part of your distributed application.

In this introduction, you’ll see how to install and use the Aspire Azure Functions integration in a simple configuration. If you already have this knowledge, see Azure Functions Hosting integration for full reference details.

Note

To follow this guide, you must have created an Aspire solution to work with. To learn how to do that, see Build your first Aspire app.

It’s expected that you’ve installed the required Azure tooling:

• Configure Visual Studio for Azure development with .NET

• Configure Visual Studio Code for Azure development with .NET

• Install the Azure Functions Core Tools

Supported scenarios

The Aspire Azure Functions integration has several key supported scenarios.

Supported triggers

The following table lists the supported triggers for Azure Functions in the Aspire integration:

Trigger	Attribute	Details
Azure Event Hubs trigger	EventHubTrigger	📦 Aspire.Hosting.Azure.EventHubs
Azure Service Bus trigger	ServiceBusTrigger	📦 Aspire.Hosting.Azure.ServiceBus
Azure Storage Blobs trigger	BlobTrigger	📦 Aspire.Hosting.Azure.Storage
Azure Storage Queues trigger	QueueTrigger	📦 Aspire.Hosting.Azure.Storage
Azure CosmosDB trigger	CosmosDbTrigger	📦 Aspire.Hosting.Azure.CosmosDB
HTTP trigger	HttpTrigger	Supported without any additional resource dependencies.
Timer trigger	TimerTrigger	Supported without any additional resource dependencies—relies on implicit host storage.

Caution

Other Azure Functions triggers and bindings aren’t currently supported in the Aspire Azure Functions integration.

For more information about the Azure Functions integration with Aspire, see Azure Functions and Aspire integration.

Set up hosting integration

To begin, install the Aspire Azure Functions Hosting integration in your Aspire AppHost project:

Aspire CLI

Aspire CLI — Add Aspire.Hosting.Azure.Functions package

aspire add azure-functions

The Aspire CLI is interactive, be sure to select the appropriate search result when prompted:

Aspire CLI — Example output prompt

Select an integration to add:

> azure-functions (Aspire.Hosting.Azure.Functions)
> Other results listed as selectable options...

Note

If there's only one result, the CLI selects it automatically. You'll still need to confirm the version.

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package Aspire.Hosting.Azure.Functions@*

PackageReference (*.csproj)

XML — Add Aspire.Hosting.Azure.Functions package reference

<PackageReference Include="Aspire.Hosting.Azure.Functions" Version="*" />

Next, in the AppHost project, add an Azure Functions resource:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var functions = builder.AddAzureFunctionsProject<Projects.ExampleFunctions>("functions")
    .WithExternalHttpEndpoints();

builder.AddProject<Projects.ExampleProject>()
    .WithReference(functions)
    .WaitFor(functions);

// After adding all resources, run the app...

builder.Build().Run();

The preceding code adds an Azure Functions project resource named functions and makes it available to other projects in your distributed application.

Continue learning

For more information on how the Azure Functions integration works, see:

Hosting integration Learn more about the Hosting integration