AzureEventHubResource

Handle

📦 Aspire.Hosting.Azure.EventHubs v13.4.0

interface AzureEventHubResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParent,
    AzureEventHubsResource]],
    IValueProvider,
    IValueWithReferences,
    IResourceWithAzureFunctionsConfig {
  readonly connectionStringExpression: ReferenceExpression;
  hubName: string;
  readonly parent: AzureEventHubsResource;
  partitionCount: number;
  addConsumerGroup(
      name: string,
      groupName?: string): AzureEventHubConsumerGroupResource;
  withProperties(configure: (obj: AzureEventHubResource) => Promise<void>): AzureEventHubResource;
}

8 members

Properties

property connectionStringExpression ReferenceExpression get

Gets the connection string expression for the Azure Event Hub.

property hubName string get · set

The event hub name.

property parent AzureEventHubsResource get

Gets the parent Azure Event Hubs resource.

property partitionCount number get · set

Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

Methods

method addConsumerGroup builder

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

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

Parameters

name string

groupName string optional

Returns

AzureEventHubConsumerGroupResource

method withProperties builder

Allows setting the properties of an Azure Event Hub resource.

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

Parameters

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

Returns

AzureEventHubResource