Frends.AzureEventHub.Receive / 3.0.0

Summary

Reads events from a consumer group, using a blob container to remember how far it has read so the next run carries on rather than starting over. It listens for a bounded period, so a run ends whether or not events arrived.

Typical use — scheduled consumption of an event stream, where the stored position is what keeps runs from overlapping or repeating

Details

Frends version: 5.7 and newer
Agent: Crossplatform
Target framework: net8.0

3.0.02026-08-13

Changed

Breaking The Consumer and Checkpoint parameter groups have been replaced with Input and Connection to align with Frends task standards:
- Input contains operational parameters:
  - Consumer.EventHubName → Input.EventHubName
  - Consumer.ConsumerGroup → Input.ConsumerGroup
  - Consumer.MaximumWaitTime → Input.MaximumWaitTime
  - Checkpoint.ContainerName → Input.ContainerName
  - Checkpoint.CreateContainer → Input.CreateContainer
- Connection contains all authentication and connection details for both the Event Hub and the checkpoint blob storage:
  - Consumer.AuthenticationMethod → Connection.EventHubAuthenticationMethod
  - Consumer.ConnectionString → Connection.EventHubConnectionString
  - Consumer.Namespace → Connection.EventHubNamespace
  - Consumer.SASToken → Connection.EventHubSASToken
  - Consumer.TenantId → Connection.EventHubTenantId
  - Consumer.ClientId → Connection.EventHubClientId
  - Consumer.ClientSecret → Connection.EventHubClientSecret
  - Checkpoint.AuthenticationMethod → Connection.StorageAuthenticationMethod
  - Checkpoint.ConnectionString → Connection.StorageConnectionString
  - Checkpoint.BlobContainerUri → Connection.BlobContainerUri
  - Checkpoint.SASToken → Connection.StorageSASToken
  - Checkpoint.TenantId → Connection.StorageTenantId
  - Checkpoint.ClientId → Connection.StorageClientId
  - Checkpoint.ClientSecret → Connection.StorageClientSecret
Added ThrowErrorOnFailure and ErrorMessageOnFailure options to the Options parameter, allowing you to control whether errors are thrown as exceptions or returned as a failed result.
The result now includes an Error property with error message and exception details when the task fails and ThrowErrorOnFailure is set to false.
Upgraded target framework from net6.0 to net8.0.

2.7.02026-04-26

Fixed

Resolve the problem with short delays between checks

2.6.02026-01-16

Changed

Update Azure packages to latest versions.
- Azure.Identity to 1.17.1
- Azure.Messaging.EventHubs to 5.12.2
- Azure.Messaging.EventHubs.Processor to 5.12.2

2.5.02025-09-22

Changed

Show ContainerName parameter only when AuthenticationMethod is set to ConnectionString.

2.4.02024-11-13

Changed

Upgraded Azure.Messaging.EventHubs to version 5.11.5.
Upgraded Azure.Messaging.EventHubs.Processor to version 5.11.5.

2.3.02024-10-30

Fixed

Issue #11 - Fixed Receive hanging in execution by adding a check for the MaximumWaitTime.

2.2.02024-08-22

Added

Updated Azure.Identity to the latest version 1.12.0.

2.1.02024-05-31

Changed

Replaced the List<> with a ConcurrentBag<> for the received messages.

2.0.12023-11-29

Fixed

Fixed ExceptionHandler check in catch and documentational fixes.

2.0.02023-10-31

Added

New property Result.Errors.

Changed

Improved descriptions and examples.
Errors and exceptions will be listed in Result.Errors if Options.ExceptionHandler is set to ExceptionHandlers.Info.
Renamed Options.MaximumWaitTimeInMinutes to Options.MaxRunTime.
Options.MaxRunTime (previously called Options.MaximumWaitTimeInMinutes) is now in seconds instead of minutes.
Consumer.MaximumWaitTime cannot exceed Options.MaxRunTime when Options.MaxRunTime is greater than 0.
Renamed Consumer.FullyQualifiedNamespace to Consumer.Namespace.
Renamed Options.Delay to Options.ConsumeAttemptDelay.
Package updates:
- Azure.Identity 1.8.2 to 1.10.3
- Azure.Messaging.EventHubs 5.9.0 to 5.9.3
- Azure.Messaging.EventHubs.Processor 5.9.0 to 5.9.3
- System.ComponentModel.Annotations 4.7.0 to 5.0.0

1.0.02023-05-31

Added

Initial implementation