AzureEventHubsResource

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

AzureEventHubsResource

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

Handle TypeScript

📦 Aspire.Hosting.Azure.EventHubs v13.2.0-preview.1.26159.1

interface AzureEventHubsResource
  extends IAzureResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithParameters,
    IValueProvider,
    IValueWithReferences,
    IAzurePrivateEndpointTarget,
    IResourceWithAzureFunctionsConfig {
  addHub(
      name: string,
      hubName?: string): AzureEventHubResource;
  runAsEmulator(configureContainer?: (obj: AzureEventHubsEmulatorResource) => void): AzureEventHubsResource;
}

Implements

• IAzureResource
• IManifestExpressionProvider
• IResource
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithParameters
• IValueProvider
• IValueWithReferences
• IAzurePrivateEndpointTarget
• IResourceWithAzureFunctionsConfig

Methods

method addHub builder

Adds an Azure Event Hub resource

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

Parameters

name string

hubName string optional

Returns

AzureEventHubResource

method runAsEmulator builder

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

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

Parameters

configureContainer (obj: AzureEventHubsEmulatorResource) => void optional

Returns

AzureEventHubsResource