Share via


ServiceBusProcessorOptions Class

Definition

The set of options that can be specified when creating a ServiceBusProcessor to configure its behavior.

public class ServiceBusProcessorOptions
type ServiceBusProcessorOptions = class
Public Class ServiceBusProcessorOptions
Inheritance
ServiceBusProcessorOptions

Constructors

ServiceBusProcessorOptions()

Properties

AutoCompleteMessages

Gets or sets a value that indicates whether the processor should automatically complete messages after the ProcessMessageAsync handler has completed processing. If the message handler triggers an exception, the message will not be automatically completed.

Identifier

A property used to set the ServiceBusProcessor ID to identify the processor. This can be used to correlate logs and exceptions. If null or empty, a random unique value will be used.

MaxAutoLockRenewalDuration

Gets or sets the maximum duration within which the lock will be renewed automatically. This value should be greater than the longest message lock duration; for example, the LockDuration Property. To specify an infinite duration, use InfiniteTimeSpan.

MaxConcurrentCalls

Gets or sets the maximum number of concurrent calls to the message handler the processor should initiate.

PrefetchCount

Gets or sets the number of messages that will be eagerly requested from Queues or Subscriptions and queued locally, intended to help maximize throughput by allowing the processor to receive from a local cache rather than waiting on a service request.

ReceiveMode

Gets or sets the ReceiveMode used to specify how messages are received.

SubQueue

Gets or sets the subqueue to connect the processor to.

Applies to