# Aspire.Hosting.Azure.EventHubs

- Module: `Aspire.Hosting.Azure.EventHubs`
- Version: `17.0.0`
- Import path: `apphost/modules/aspire`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f)
- Functions: `8`
- Types: `18`

## Handles

- [AzureBicepResource](/reference/api/go/aspire.hosting.azure.eventhubs/azurebicepresource.md) -- `handle` - 0 members
- [AzureBlobStorageContainerResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureblobstoragecontainerresource.md) -- `handle` - 0 members
- [AzureBlobStorageResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureblobstorageresource.md) -- `handle` - 0 members
- [AzureDataLakeStorageFileSystemResource](/reference/api/go/aspire.hosting.azure.eventhubs/azuredatalakestoragefilesystemresource.md) -- `handle` - 0 members
- [AzureDataLakeStorageResource](/reference/api/go/aspire.hosting.azure.eventhubs/azuredatalakestorageresource.md) -- `handle` - 0 members
- [AzureEnvironmentResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureenvironmentresource.md) -- `handle` - 0 members
- [AzureEventHubConsumerGroupResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureeventhubconsumergroupresource.md) -- `handle` - 0 members
- [AzureEventHubResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureeventhubresource.md) -- `handle` - 7 members -- Represents an Azure Event Hub. Initializes a new instance of the `AzureEventHubResource` class.
- [AzureEventHubsEmulatorResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureeventhubsemulatorresource.md) -- `handle` - 2 members
- [AzureEventHubsResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureeventhubsresource.md) -- `handle` - 2 members -- Represents an Azure Event Hubs resource.
- [AzureProvisioningResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureprovisioningresource.md) -- `handle` - 0 members
- [AzureQueueStorageQueueResource](/reference/api/go/aspire.hosting.azure.eventhubs/azurequeuestoragequeueresource.md) -- `handle` - 0 members
- [AzureQueueStorageResource](/reference/api/go/aspire.hosting.azure.eventhubs/azurequeuestorageresource.md) -- `handle` - 0 members
- [AzureStorageEmulatorResource](/reference/api/go/aspire.hosting.azure.eventhubs/azurestorageemulatorresource.md) -- `handle` - 0 members
- [AzureStorageResource](/reference/api/go/aspire.hosting.azure.eventhubs/azurestorageresource.md) -- `handle` - 0 members
- [AzureTableStorageResource](/reference/api/go/aspire.hosting.azure.eventhubs/azuretablestorageresource.md) -- `handle` - 0 members
- [AzureUserAssignedIdentityResource](/reference/api/go/aspire.hosting.azure.eventhubs/azureuserassignedidentityresource.md) -- `handle` - 0 members

## Enums

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

## Functions

- [AddConsumerGroup](/reference/api/go/aspire.hosting.azure.eventhubs/addconsumergroup.md) -- `method` - on `AzureEventHubResource` -- Adds an Azure Event Hub Consumer Group resource to the application model.
- [WithProperties](/reference/api/go/aspire.hosting.azure.eventhubs/withproperties.md) -- `method` - on `AzureEventHubResource` -- Allows setting the properties of an Azure Event Hub resource.
- [WithConfigurationFile](/reference/api/go/aspire.hosting.azure.eventhubs/withconfigurationfile.md) -- `method` - on `AzureEventHubsEmulatorResource` -- Adds a bind mount for the configuration file of an Azure Event Hubs emulator resource.
- [WithHostPort](/reference/api/go/aspire.hosting.azure.eventhubs/withhostport.md) -- `method` - on `AzureEventHubsEmulatorResource` -- Configures the host port for the Azure Event Hubs emulator is exposed on instead of using randomly assigned port.
- [AddHub](/reference/api/go/aspire.hosting.azure.eventhubs/addhub.md) -- `method` - on `AzureEventHubsResource` -- Adds an Azure Event Hubs hub resource to the application model.
- [RunAsEmulator](/reference/api/go/aspire.hosting.azure.eventhubs/runasemulator.md) -- `method` - on `AzureEventHubsResource` -- Configures the Azure Event Hubs resource to run with the local emulator
- [AddAzureEventHubs](/reference/api/go/aspire.hosting.azure.eventhubs/addazureeventhubs.md) -- `method` - on `DistributedApplicationBuilder` -- Adds an Azure Event Hubs Namespace resource to the application model. This resource can be used to create Event Hub resources.
- [WithEventHubsRoleAssignments](/reference/api/go/aspire.hosting.azure.eventhubs/witheventhubsroleassignments.md) -- `method` - on `Resource` -- 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.
