EventHubConsumerGroup Class

The name of the default ConsumerGroup that is pre-created when creating EventHub.

The constant that denotes the end of a stream. This can be used as an offset argument in receiver creation to start receiving from the latest event, instead of a specific point in time/offset value.

The constant that denotes the start of a stream. This can be used as an offset argument in receiver creation.

Gets or sets a value indicating whether the runtime metric of a receiver is enabled.

Gets the event hub path.

Gets the name of the consumer group.

Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from EventHubClient. The default value is 10,000.

Gets or sets the maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the SerializedSizeInBytes property.

Performs abort functionality on the messaging entity.

Sends a cleanup message to Service Bus to signal the completion of the usage of an entity.

Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity.

Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting position. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, and the specified epoch value. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Asynchronous version of CreateReceiver(String, DateTime, Int64, ReceiverOptions).

Asynchronous version of CreateReceiver(String, DateTime, ReceiverOptions).

Asynchronous version of CreateReceiver(String, EventPosition, Nullable<Int64>, ReceiverOptions).

Asynchronous version of CreateReceiver(String, Int64, ReceiverOptions).

Asynchronous version of CreateReceiver(String, ReceiverOptions).

Asynchronous version of CreateReceiver(String, String, Boolean, Int64, ReceiverOptions).

Asynchronous version of CreateReceiver(String, String, Boolean, ReceiverOptions).

Asynchronous version of CreateReceiver(String, String, Int64, ReceiverOptions).

Asynchronous version of CreateReceiver(String, ReceiverOptions).

For internal use only. Do not inherit from this class.

Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions).

Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager).

Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions).

Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory).

Unregisters IEventProcessor for the partition specified by PartitionId. This results in CloseAsync(PartitionContext, CloseReason) being called on the underlying event processor.

Asynchronous version of UnregisterProcessor(Lease, CloseReason).