Aspire.Hosting.Azure.EventHubs

Docs/Reference/Search TypeScript APIs/Aspire.Hosting.Azure.EventHubs

Aspire.Hosting.Azure.EventHubs

Docs Reference Search TypeScript APIs Aspire.Hosting.Azure.EventHubs

Official

📦 Aspire.Hosting.Azure.EventHubsv13.4.0

8Functions

5Types

Search types, functions, members in Aspire.Hosting.Azure.EventHubs...

enumhandlemethodproperty

5 types and 6 membersClear filters

Types

handleAzureEventHubConsumerGroupResource

handleAzureEventHubResource8 members

handleAzureEventHubsEmulatorResource2 members

handleAzureEventHubsResource2 members

Functions

methodaddAzureEventHubsbuilder

Adds an Azure Event Hubs Namespace resource to the application model. This resource can be used to create Event Hub resources.

addAzureEventHubs(name: string): AzureEventHubsResource

methodaddConsumerGroupbuilder

Adds an Azure Event Hub Consumer Group resource to the application model.

addConsumerGroup(name: string, groupName?: string): AzureEventHubConsumerGroupResource

methodaddHubbuilder

Adds an Azure Event Hubs hub resource to the application model.

addHub(name: string, hubName?: string): AzureEventHubResource

methodrunAsEmulatorbuilder

Configures the Azure Event Hubs resource to run with the local emulator

runAsEmulator(configureContainer?: (obj: AzureEventHubsEmulatorResource) => Promise<void>): AzureEventHubsResource

methodwithConfigurationFilebuilder

Adds a bind mount for the configuration file of an Azure Event Hubs emulator resource.

withConfigurationFile(path: string): AzureEventHubsEmulatorResource

methodwithEventHubsRoleAssignmentsbuilder

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.

withEventHubsRoleAssignments(target: AzureEventHubsResource, roles: AzureEventHubsRole[]): IResource

methodwithHostPortbuilder

Configures the host port for the Azure Event Hubs emulator is exposed on instead of using randomly assigned port.

withHostPort(port: number): AzureEventHubsEmulatorResource

methodwithPropertiesbuilder

Allows setting the properties of an Azure Event Hub resource.

withProperties(configure: (obj: AzureEventHubResource) => Promise<void>): AzureEventHubResource

Enums

enumAzureEventHubsRole3 values