Aspire.Hosting.Azure.EventHubs

Azure Event Hubs hosting integration

Use this integration to model, configure, and orchestrate Azure Event Hubs in an Aspire solution.

Getting started

Prerequisites

• Azure subscription - create one for free

Add the integration

From your AppHost directory, add the Aspire.Hosting.Azure.EventHubs integration with the Aspire CLI:

aspire add Aspire.Hosting.Azure.EventHubs

Configure Azure Provisioning for local development

Adding Azure resources to the AppHost model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via AppHost configuration. From your AppHost directory, set these values with aspire secret set:

aspire secret set Azure:SubscriptionId "<your subscription id>"
aspire secret set Azure:ResourceGroupPrefix "<prefix for the resource group>"
aspire secret set Azure:Location "<azure location>"

NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.

Usage example

In the AppHost, add an Event Hubs connection and reference it from another resource with either C# or TypeScript:

C#

var eventHubs = builder.AddAzureEventHubs("eh");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(eventHubs);

TypeScript

const eventHubs = await builder.addAzureEventHubs("eh");

const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
                       .withReference(eventHubs);

Connection Properties

When you reference Azure Event Hubs resources using WithReference, the following connection properties are made available to the consuming project:

Event Hubs namespace

The Event Hubs namespace resource exposes the following connection properties:

Event Hub

The Event Hub resource inherits all properties from its parent Event Hubs namespace and adds:

Event Hub consumer group

The Event Hub consumer group resource inherits all properties from its parent Event Hub and adds:

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.

Additional documentation

• https://aspire.dev/integrations/gallery/
• https://aspire.dev/integrations/cloud/azure/azure-event-hubs/azure-event-hubs-host/
• https://learn.microsoft.com/azure/event-hubs/event-hubs-about

Feedback & contributing

https://github.com/microsoft/aspire