Class EventHubConsumerGroup

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Represents the consumer group within an Event Hub. This class creates receivers for a specific consumer group within an Event Hub. This can be the default consumer group or another user-created consumer group.

public sealed class EventHubConsumerGroup : ClientEntity

Inheritance

object

ClientEntity

EventHubConsumerGroup

Inherited Members

ClientEntity.Abort()

ClientEntity.Close()

ClientEntity.CloseAsync()

ClientEntity.RetryPolicy

ClientEntity.IsClosed

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

DefaultGroupName

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

public const string DefaultGroupName = "$Default"

Field Value

string

See Also

GetDefaultConsumerGroup()

EndOfStream

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.

public const string EndOfStream = "@latest"

Field Value

string

See Also

CreateReceiver(string, ReceiverOptions)

StartOfStream

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

public const string StartOfStream = "-1"

Field Value

string

See Also

CreateReceiver(string, ReceiverOptions)

Properties

EnableReceiverRuntimeMetric

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

public bool EnableReceiverRuntimeMetric { get; set; }

Property Value

bool

true if a client wants to access ReceiverRuntimeInfo using EventHubReceiver.

Remarks

Its default value is derived from the value of EnableReceiverRuntimeMetric

EventHubPath

Gets the event hub path.

public string EventHubPath { get; }

Property Value

string

The event hub path

GroupName

Gets the name of the consumer group.

public string GroupName { get; }

Property Value

string

The name of the consumer group.

PrefetchCount

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.

public int PrefetchCount { get; set; }

Property Value

int

The number of events that the receiver can cache.

Remarks

Any EventHubReceiver created from this instance will inherit this value by default. Changes to this value will not be propagate to already created receiver, but will be used by new EventHubReceiver created after the change. Also setting this property to non-zero will set PrefetchSizeInBytes to null. Note that setting the count too low will affect the effective performance of the event hub receive call.

Exceptions

ArgumentOutOfRangeException

Thrown if the value is less than the minimum required value of 10.

PrefetchSizeInBytes

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.

public long? PrefetchSizeInBytes { get; set; }

Property Value

long?

Returns long.

Remarks

The size limit is not an absolute limit. the size might go over by at least one event data worth of size. Any EventHubReceiver created from this instance will inherit this value by default. Changes to this value will not be propagate to already created receiver, but will be used by new EventHubReceiver created after the change. Also, setting this property to non-null value will set PrefetchCount to zero. Note that setting the size too low will affect the effective performance of the Event Hub receive call.

Exceptions

ArgumentOutOfRangeException

Thrown when the size value is less than the minimum required value of 260K bytes.

Methods

CreateReceiver(string, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns the EventHubReceiver object that is tied to the given Event Hubs partition.

Remarks

If the EventHubConsumerGroup has checkpoint enabled, this overload will always throw InvalidOperationException because checkpoint enabled ConsumerGroup requires epoch to work (please use the overload that supply epoch as input argument). If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the Event Hub.

Exceptions

MessagingException

Thrown if the service encounters a transient error.

MessagingCommunicationException

Thrown if the client has a problem connecting to the service.

ArgumentOutOfRangeException

Thrown if partitionId is not within the expected range, as determined by the PartitionCount property.

System.ServiceModel.QuotaExceededException

Thrown if the number of receivers currently connected to the partition specified by partitionId has exceeded the maximum allowed quota set by the service.

ReceiverDisconnectedException

Thrown if there is currently a receiver connected to the partition as specified by partitionId.

CreateReceiver(string, DateTime, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, DateTime startingDateTimeUtc, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingDateTimeUtc DateTime

The starting UTC time for receiving messages.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns the EventHubReceiver.

Remarks

Service only uses this startingDateTimeUtc as an approximation when determining next event to deliver.

        Keep in mind that there can be clock skew between client time and service time, so user application 
        should be designed to handle duplication in event delivery.

Exceptions

MessagingException

Thrown if the service encounters a transient error.

MessagingCommunicationException

Thrown if the client has a problem connecting to the service.

ArgumentOutOfRangeException

Thrown if partitionId is not within the expected range, as determined by the PartitionCount property.

System.ServiceModel.QuotaExceededException

Thrown if the number of receivers currently connected to the partition specified by partitionId has exceeded the maximum allowed quota set by the service.

ReceiverDisconnectedException

Thrown if there is currently a receiver connected to the partition as specified by partitionId, with an startingDateTimeUtc specified.

CreateReceiver(string, DateTime, long, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, DateTime startingDateTimeUtc, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingDateTimeUtc DateTime

The starting UTC time for receiving messages.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns the EventHubReceiver.

Remarks

Service only uses this startingDateTimeUtc as an approximation when determining next event to deliver.

        Keep in mind that there can be clock skew between client time and service time, so user application 
        should be designed to handle duplication in event delivery.

Exceptions

MessagingException

Thrown if the service encounters a transient error.

MessagingCommunicationException

Thrown if the client has a problem connecting to the service.

ArgumentOutOfRangeException

Thrown if partitionId is not within the expected range, as determined by the PartitionCount property.

CreateReceiver(string, long, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns the EventHubReceiver.

Remarks

If the EventHubConsumerGroup has checkpoint enabled, then the receiver will get next message from the checkpoint offset. If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the event hub.

Exceptions

MessagingException

Thrown if the service encounters a transient error.

MessagingCommunicationException

Thrown if the client has a problem connecting to the service.

ArgumentOutOfRangeException

Thrown if partitionId is not within the expected range, as determined by the PartitionCount property.

CreateReceiver(string, string, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns the EventHubReceiver.

Exceptions

ArgumentOutOfRangeException

Thrown if partitionId is not within the expected range, as determined by the PartitionCount property.

System.ServiceModel.QuotaExceededException

Thrown if the number of receivers currently connected to the partition specified by partitionId has exceeded the maximum allowed quota set by the service.

ReceiverDisconnectedException

Thrown if there is currently a receiver connected to the partition as specified by partitionId, with an startingOffset specified.

CreateReceiver(string, string, bool, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, bool offsetInclusive, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages.

offsetInclusive bool

A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first Options for a event hub receiver. event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

receiverOptions ReceiverOptions

Returns

EventHubReceiver

Returns EventHubReceiver.

CreateReceiver(string, string, bool, long, ReceiverOptions)

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.

public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, bool offsetInclusive, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages.

offsetInclusive bool

A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns EventHubReceiver.

CreateReceiver(string, string, long, ReceiverOptions)

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

public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages. To specify the start of the stream, see StartOfStream.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

EventHubReceiver

Returns the EventHubReceiver.

Exceptions

MessagingException

Thrown if the service encounters a transient error.

MessagingCommunicationException

Thrown if the client has a problem connecting to the service.

ArgumentOutOfRangeException

Thrown if partitionId is not within the expected range, as determined by the PartitionCount property.

CreateReceiverAsync(string, ReceiverOptions)

Asynchronous version of CreateReceiver(string, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

Remarks

If the EventHubConsumerGroup has checkpoint enabled, this overload will always throw InvalidOperationException because checkpoint enabled ConsumerGroup requires epoch to work (please use the overload that supply epoch as input argument). If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the Event Hub.

CreateReceiverAsync(string, DateTime, ReceiverOptions)

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

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, DateTime startingDateTimeUtc, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingDateTimeUtc DateTime

The starting UTC time for receiving messages.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

Remarks

Service only use this startingDateTimeUtc as an approximation when determining next event to deliver.

        Keep in mind that there can be clock skew between client time and service time, so user application 
        should be designed to handle duplication in event delivery.

CreateReceiverAsync(string, DateTime, long, ReceiverOptions)

Asynchronous version of CreateReceiver(string, DateTime, long, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, DateTime startingDateTimeUtc, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingDateTimeUtc DateTime

The starting UTC time for receiving messages.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

Remarks

Service only uses this startingDateTimeUtc as an approximation when determining next event to deliver.

        Keep in mind that there can be clock skew between client time and service time, so user application 
        should be designed to handle duplication in event delivery.

CreateReceiverAsync(string, long, ReceiverOptions)

Asynchronous version of CreateReceiver(string, long, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

Remarks

If the EventHubConsumerGroup has checkpoint enabled, then the receiver will get next message from the checkpoint offset. If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the Event Hub.

CreateReceiverAsync(string, string, ReceiverOptions)

Asynchronous version of CreateReceiver(string, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

CreateReceiverAsync(string, string, bool, ReceiverOptions)

Asynchronous version of CreateReceiver(string, string, bool, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, bool offsetInclusive, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages.

offsetInclusive bool

A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

CreateReceiverAsync(string, string, bool, long, ReceiverOptions)

Asynchronous version of CreateReceiver(string, string, bool, long, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, bool offsetInclusive, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages.

offsetInclusive bool

A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

CreateReceiverAsync(string, string, long, ReceiverOptions)

Asynchronous version of CreateReceiver(string, string, long, ReceiverOptions).

public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, long epoch, ReceiverOptions receiverOptions = null)

Parameters

partitionId string

The ID of the partition.

startingOffset string

The starting offset at which to start receiving messages. To specify the start of the stream, see StartOfStream.

epoch long

The epoch value. The service uses this value to enforce partition/lease ownership.

receiverOptions ReceiverOptions

Options for a event hub receiver.

Returns

Task<EventHubReceiver>

Returns Task<TResult>.

OnAbort()

protected override void OnAbort()

OnBeginClose(TimeSpan, AsyncCallback, object)

protected override IAsyncResult OnBeginClose(TimeSpan timeout, AsyncCallback callback, object state)

Parameters

timeout TimeSpan

callback AsyncCallback

state object

Returns

IAsyncResult

Returns IAsyncResult.

OnBeginOpen(TimeSpan, AsyncCallback, object)

protected override IAsyncResult OnBeginOpen(TimeSpan timeout, AsyncCallback callback, object state)

Parameters

timeout TimeSpan

callback AsyncCallback

state object

Returns

IAsyncResult

Returns IAsyncResult.

OnClose(TimeSpan)

protected override void OnClose(TimeSpan timeout)

Parameters

timeout TimeSpan

OnEndClose(IAsyncResult)

protected override void OnEndClose(IAsyncResult result)

Parameters

result IAsyncResult

OnEndOpen(IAsyncResult)

protected override void OnEndOpen(IAsyncResult result)

Parameters

result IAsyncResult

RegisterProcessorAsync<T>(Lease, ICheckpointManager)

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

public Task RegisterProcessorAsync<T>(Lease lease, ICheckpointManager checkpointManager) where T : IEventProcessor

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

Returns

Task

A task instance that represents the asynchronous operation.

Type Parameters

T

Implementation of IEventProcessor.

RegisterProcessorAsync<T>(Lease, ICheckpointManager, EventProcessorOptions)

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

public Task RegisterProcessorAsync<T>(Lease lease, ICheckpointManager checkpointManager, EventProcessorOptions processorOptions) where T : IEventProcessor

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

processorOptions EventProcessorOptions

An EventProcessorOptions object.

Returns

Task

Returns Task.

Type Parameters

T

Implementation of IEventProcessor.

Remarks

To perform more advanced IEventProcessor creation, implement an IEventProcessorFactory class which allows you to control how event processors are created.

RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory)

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.

public void RegisterProcessorFactory(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory)

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

eventProcessorFactory IEventProcessorFactory

Factory to create an instance of IEventProcessor.

RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

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.

public void RegisterProcessorFactory(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory, EventProcessorOptions processorOptions)

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

eventProcessorFactory IEventProcessorFactory

Factory to create an instance of IEventProcessor.

processorOptions EventProcessorOptions

An EventProcessorOptions object.

RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory)

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

public Task RegisterProcessorFactoryAsync(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory)

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

eventProcessorFactory IEventProcessorFactory

Factory to create an instance of IEventProcessor.

Returns

Task

A task instance that represents the asynchronous operation.

RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

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

public Task RegisterProcessorFactoryAsync(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory, EventProcessorOptions processorOptions)

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

eventProcessorFactory IEventProcessorFactory

Factory to create an instance of IEventProcessor.

processorOptions EventProcessorOptions

An EventProcessorOptions object.

Returns

Task

Returns Task.

RegisterProcessor<T>(Lease, 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.

public void RegisterProcessor<T>(Lease lease, ICheckpointManager checkpointManager) where T : IEventProcessor

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

Type Parameters

T

Implementation of IEventProcessor.

Remarks

To perform more advanced IEventProcessor creation, implement an IEventProcessorFactory class which allows you to control how event processors are created.

RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions)

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.

public void RegisterProcessor<T>(Lease lease, ICheckpointManager checkpointManager, EventProcessorOptions processorOptions) where T : IEventProcessor

Parameters

lease Lease

Partition information.

checkpointManager ICheckpointManager

Checkpoints the offset for the specified partition when CheckpointAsync(EventData) is called.

processorOptions EventProcessorOptions

An EventProcessorOptions object.

Type Parameters

T

Implementation of IEventProcessor.

Remarks

To perform more advanced IEventProcessor creation, implement an IEventProcessorFactory class which allows you to control how event processors are created.

UnregisterProcessor(Lease, CloseReason)

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

public void UnregisterProcessor(Lease lease, CloseReason reason)

Parameters

lease Lease

Partition information.

reason CloseReason

Reason for which UnregisterProcessor(Lease, CloseReason) was called.

UnregisterProcessorAsync(Lease, CloseReason)

Asynchronous version of UnregisterProcessor(Lease, CloseReason).

public Task UnregisterProcessorAsync(Lease lease, CloseReason reason)

Parameters

lease Lease

Partition information.

reason CloseReason

Reason that UnregisterProcessorAsync(Lease, CloseReason) was called.

Returns

Task

A task instance that represents the asynchronous operation.

Events

EventProcessorLifeCycleManagerFaulted

public event EventHandler<EventProcessorFaultedEventArgs> EventProcessorLifeCycleManagerFaulted

Event Type

EventHandler<EventProcessorFaultedEventArgs>