# Aspire.Hosting.Azure.EventHubs

- Module: `Aspire.Hosting.Azure.EventHubs`
- Version: `13.4.0`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `8`
- Types: `5`

## Types

- [AzureEventHubConsumerGroupResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubconsumergroupresource.md) -- `handle` - 0 members
- [AzureEventHubResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource.md) -- `handle` - 8 members -- Represents an Azure Event Hub. Initializes a new instance of the {@ats-ref type:AzureEventHubResource} class.
- [AzureEventHubsEmulatorResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsemulatorresource.md) -- `handle` - 2 members
- [AzureEventHubsResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsresource.md) -- `handle` - 2 members -- Represents an Azure Event Hubs resource.

## Functions

- [addAzureEventHubs](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureeventhubs.md) -- `method` -- Adds an Azure Event Hubs Namespace resource to the application model. This resource can be used to create Event Hub resources.
- [addConsumerGroup](/reference/api/typescript/aspire.hosting.azure.eventhubs/addconsumergroup.md) -- `method` -- Adds an Azure Event Hub Consumer Group resource to the application model.
- [addHub](/reference/api/typescript/aspire.hosting.azure.eventhubs/addhub.md) -- `method` -- Adds an Azure Event Hubs hub resource to the application model.
- [runAsEmulator](/reference/api/typescript/aspire.hosting.azure.eventhubs/runasemulator.md) -- `method` -- Configures the Azure Event Hubs resource to run with the local emulator
- [withConfigurationFile](/reference/api/typescript/aspire.hosting.azure.eventhubs/withconfigurationfile.md) -- `method` -- Adds a bind mount for the configuration file of an Azure Event Hubs emulator resource.
- [withEventHubsRoleAssignments](/reference/api/typescript/aspire.hosting.azure.eventhubs/witheventhubsroleassignments.md) -- `method` -- Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Event Hubs Namespace resource. This replaces the default role assignments for the resource.
- [withHostPort](/reference/api/typescript/aspire.hosting.azure.eventhubs/withhostport.md) -- `method` -- Configures the host port for the Azure Event Hubs emulator is exposed on instead of using randomly assigned port.
- [withProperties](/reference/api/typescript/aspire.hosting.azure.eventhubs/withproperties.md) -- `method` -- Allows setting the properties of an Azure Event Hub resource.

## Enums

- [AzureEventHubsRole](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsrole.md) -- `enum` - 3 values -- Represents ATS-compatible Azure Event Hubs roles.