# Aspire.Hosting.Azure.EventHubs

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

## Types

- [AzureBicepResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azurebicepresource.md) -- `handle` - 9 members
- [AzureBlobStorageContainerResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureblobstoragecontainerresource.md) -- `handle` - 0 members
- [AzureBlobStorageResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureblobstorageresource.md) -- `handle` - 0 members
- [AzureDataLakeStorageFileSystemResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azuredatalakestoragefilesystemresource.md) -- `handle` - 0 members
- [AzureDataLakeStorageResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azuredatalakestorageresource.md) -- `handle` - 0 members
- [AzureEnvironmentResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureenvironmentresource.md) -- `handle` - 2 members
- [AzureEventHubConsumerGroupResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubconsumergroupresource.md) -- `handle` - 0 members
- [AzureEventHubResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource.md) -- `handle` - 7 members
- [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
- [AzureProvisioningResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureprovisioningresource.md) -- `handle` - 1 members
- [AzureQueueStorageQueueResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azurequeuestoragequeueresource.md) -- `handle` - 0 members
- [AzureQueueStorageResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azurequeuestorageresource.md) -- `handle` - 0 members
- [AzureResourceInfrastructure](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureresourceinfrastructure.md) -- `handle` - 3 members
- [AzureStorageEmulatorResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azurestorageemulatorresource.md) -- `handle` - 6 members
- [AzureStorageResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azurestorageresource.md) -- `handle` - 8 members
- [AzureTableStorageResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azuretablestorageresource.md) -- `handle` - 0 members
- [AzureUserAssignedIdentityResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureuserassignedidentityresource.md) -- `handle` - 0 members
- [BicepOutputReference](/reference/api/typescript/aspire.hosting.azure.eventhubs/bicepoutputreference.md) -- `handle` - 3 members
- [IAzureKeyVaultResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/iazurekeyvaultresource.md) -- `interface` - 0 members
- [IAzureKeyVaultSecretReference](/reference/api/typescript/aspire.hosting.azure.eventhubs/iazurekeyvaultsecretreference.md) -- `interface` - 0 members
- [IAzureResource](/reference/api/typescript/aspire.hosting.azure.eventhubs/iazureresource.md) -- `interface` - 9 members

## Functions

- [addAzureEnvironment](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureenvironment.md) -- `method` -- Adds the shared Azure environment resource to the application model
- [addAzureEventHubs](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureeventhubs.md) -- `method` -- Adds an Azure Event Hubs namespace resource
- [addAzureInfrastructure](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureinfrastructure.md) -- `method` -- Adds an Azure provisioning resource to the application model
- [addAzureProvisioning](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureprovisioning.md) -- `method` -- Adds Azure provisioning services to the distributed application builder
- [addAzureStorage](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazurestorage.md) -- `method` -- Adds an Azure Storage resource
- [addAzureUserAssignedIdentity](/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureuserassignedidentity.md) -- `method` -- Adds an Azure user-assigned identity resource
- [addBicepTemplate](/reference/api/typescript/aspire.hosting.azure.eventhubs/addbiceptemplate.md) -- `method` -- Adds an Azure Bicep template resource from a file
- [addBicepTemplateString](/reference/api/typescript/aspire.hosting.azure.eventhubs/addbiceptemplatestring.md) -- `method` -- Adds an Azure Bicep template resource from inline Bicep content
- [addBlobContainer](/reference/api/typescript/aspire.hosting.azure.eventhubs/addblobcontainer.md) -- `method` -- Adds an Azure Blob Storage container resource
- [addBlobs](/reference/api/typescript/aspire.hosting.azure.eventhubs/addblobs.md) -- `method` -- Adds an Azure Blob Storage resource
- [addConsumerGroup](/reference/api/typescript/aspire.hosting.azure.eventhubs/addconsumergroup.md) -- `method` -- Adds an Azure Event Hub consumer group resource
- [addDataLake](/reference/api/typescript/aspire.hosting.azure.eventhubs/adddatalake.md) -- `method` -- Adds an Azure Data Lake Storage resource
- [addDataLakeFileSystem](/reference/api/typescript/aspire.hosting.azure.eventhubs/adddatalakefilesystem.md) -- `method` -- Adds an Azure Data Lake Storage file system resource
- [addHub](/reference/api/typescript/aspire.hosting.azure.eventhubs/addhub.md) -- `method` -- Adds an Azure Event Hub resource
- [addQueue](/reference/api/typescript/aspire.hosting.azure.eventhubs/addqueue.md) -- `method` -- Adds an Azure Storage queue resource
- [addQueues](/reference/api/typescript/aspire.hosting.azure.eventhubs/addqueues.md) -- `method` -- Adds an Azure Queue Storage resource
- [addTables](/reference/api/typescript/aspire.hosting.azure.eventhubs/addtables.md) -- `method` -- Adds an Azure Table Storage resource
- [asExisting](/reference/api/typescript/aspire.hosting.azure.eventhubs/asexisting.md) -- `method` -- Marks an Azure resource as existing in both run and publish modes by using parameter resources
- [clearDefaultRoleAssignments](/reference/api/typescript/aspire.hosting.azure.eventhubs/cleardefaultroleassignments.md) -- `method` -- Clears the default Azure role assignments from a resource
- [configureInfrastructure](/reference/api/typescript/aspire.hosting.azure.eventhubs/configureinfrastructure.md) -- `method` -- Configures the Azure provisioning infrastructure callback
- [getBicepIdentifier](/reference/api/typescript/aspire.hosting.azure.eventhubs/getbicepidentifier.md) -- `method` -- Gets the normalized Bicep identifier for an Azure resource
- [getOutput](/reference/api/typescript/aspire.hosting.azure.eventhubs/getoutput.md) -- `method` -- Gets an output reference from an Azure Bicep template resource
- [isExisting](/reference/api/typescript/aspire.hosting.azure.eventhubs/isexisting.md) -- `method` -- Determines whether a resource is marked as existing
- [publishAsConnectionString](/reference/api/typescript/aspire.hosting.azure.eventhubs/publishasconnectionstring.md) -- `method` -- Publishes an Azure resource to the manifest as a connection string
- [publishAsExisting](/reference/api/typescript/aspire.hosting.azure.eventhubs/publishasexisting.md) -- `method` -- Marks an Azure resource as existing in publish mode
- [publishAsExistingFromParameters](/reference/api/typescript/aspire.hosting.azure.eventhubs/publishasexistingfromparameters.md) -- `method` -- Marks an Azure resource as existing in publish mode by using parameter resources
- [runAsEmulator](/reference/api/typescript/aspire.hosting.azure.eventhubs/runasemulator.md) -- `method` -- Configures the Azure Event Hubs resource to run with the local emulator
- [runAsEmulator](/reference/api/typescript/aspire.hosting.azure.eventhubs/runasemulator.md) -- `method` -- Configures the Azure Storage resource to be emulated using Azurite
- [runAsExisting](/reference/api/typescript/aspire.hosting.azure.eventhubs/runasexisting.md) -- `method` -- Marks an Azure resource as existing in run mode
- [runAsExistingFromParameters](/reference/api/typescript/aspire.hosting.azure.eventhubs/runasexistingfromparameters.md) -- `method` -- Marks an Azure resource as existing in run mode by using parameter resources
- [withApiVersionCheck](/reference/api/typescript/aspire.hosting.azure.eventhubs/withapiversioncheck.md) -- `method` -- Configures whether the emulator checks API version validity
- [withAzureUserAssignedIdentity](/reference/api/typescript/aspire.hosting.azure.eventhubs/withazureuserassignedidentity.md) -- `method` -- Associates an Azure user-assigned identity with a compute resource
- [withBlobPort](/reference/api/typescript/aspire.hosting.azure.eventhubs/withblobport.md) -- `method` -- Sets the host port for blob requests on the storage emulator
- [withConfigurationFile](/reference/api/typescript/aspire.hosting.azure.eventhubs/withconfigurationfile.md) -- `method` -- Sets the emulator configuration file path
- [withDataBindMount](/reference/api/typescript/aspire.hosting.azure.eventhubs/withdatabindmount.md) -- `method` -- Adds a bind mount for the data folder to an Azure Storage emulator resource
- [withDataVolume](/reference/api/typescript/aspire.hosting.azure.eventhubs/withdatavolume.md) -- `method` -- Adds a named volume for the data folder to an Azure Storage emulator resource
- [withEnvironmentFromKeyVaultSecret](/reference/api/typescript/aspire.hosting.azure.eventhubs/withenvironmentfromkeyvaultsecret.md) -- `method` -- Sets an environment variable from an Azure Key Vault secret reference
- [withEnvironmentFromOutput](/reference/api/typescript/aspire.hosting.azure.eventhubs/withenvironmentfromoutput.md) -- `method` -- Sets an environment variable from a Bicep output reference
- [withEventHubsRoleAssignments](/reference/api/typescript/aspire.hosting.azure.eventhubs/witheventhubsroleassignments.md) -- `method` -- Assigns Event Hubs roles to a resource
- [withHostPort](/reference/api/typescript/aspire.hosting.azure.eventhubs/withhostport.md) -- `method` -- Sets the host port for the Event Hubs emulator endpoint
- [withLocation](/reference/api/typescript/aspire.hosting.azure.eventhubs/withlocation.md) -- `method` -- Sets the Azure location for the shared Azure environment resource
- [withParameter](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameter.md) -- `method` -- Adds a Bicep parameter without a value
- [withParameterFromConnectionString](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterfromconnectionstring.md) -- `method` -- Adds a Bicep parameter from a connection string resource builder
- [withParameterFromEndpoint](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterfromendpoint.md) -- `method` -- Adds a Bicep parameter from an endpoint reference
- [withParameterFromOutput](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterfromoutput.md) -- `method` -- Adds a Bicep parameter from another Bicep output reference
- [withParameterFromParameter](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterfromparameter.md) -- `method` -- Adds a Bicep parameter from a parameter resource builder
- [withParameterFromReferenceExpression](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterfromreferenceexpression.md) -- `method` -- Adds a Bicep parameter from a reference expression
- [withParameterStringValue](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterstringvalue.md) -- `method` -- Adds a Bicep parameter with a string value
- [withParameterStringValues](/reference/api/typescript/aspire.hosting.azure.eventhubs/withparameterstringvalues.md) -- `method` -- Adds a Bicep parameter with a string list value
- [withProperties](/reference/api/typescript/aspire.hosting.azure.eventhubs/withproperties.md) -- `method` -- Configures properties of an Azure Event Hub
- [withQueuePort](/reference/api/typescript/aspire.hosting.azure.eventhubs/withqueueport.md) -- `method` -- Sets the host port for queue requests on the storage emulator
- [withResourceGroup](/reference/api/typescript/aspire.hosting.azure.eventhubs/withresourcegroup.md) -- `method` -- Sets the Azure resource group for the shared Azure environment resource
- [withStorageRoleAssignments](/reference/api/typescript/aspire.hosting.azure.eventhubs/withstorageroleassignments.md) -- `method` -- Assigns Azure Storage roles to a resource
- [withTablePort](/reference/api/typescript/aspire.hosting.azure.eventhubs/withtableport.md) -- `method` -- Sets the host port for table requests on the storage emulator

## Enums

- [AzureEventHubsRole](/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsrole.md) -- `enum` - 3 values
- [AzureStorageRole](/reference/api/typescript/aspire.hosting.azure.eventhubs/azurestoragerole.md) -- `enum` - 20 values
- [DeploymentScope](/reference/api/typescript/aspire.hosting.azure.eventhubs/deploymentscope.md) -- `enum` - 4 values