ServiceBusOptions Class

Definition

Configuration options for the ServiceBus extension.

public class ServiceBusOptions : Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter
type ServiceBusOptions = class
    interface IOptionsFormatter
Public Class ServiceBusOptions
Implements IOptionsFormatter
Inheritance
System.Object
ServiceBusOptions
Implements
Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter

Constructors

ServiceBusOptions()

Constructs a new instance.

Properties

AutoCompleteMessages

Gets or sets whether to automatically complete messages after successful execution of the function. The default value is true.

ClientRetryOptions

The set of options to use for determining whether a failed operation should be retried and, if so, the amount of time to wait between retry attempts. These options also control the amount of time allowed for receiving messages and other interactions with the Service Bus service.

ExceptionHandler

Gets or sets an optional exception handler that will be invoked if an exception occurs while attempting to process a message. This does not apply for functions that receive a batch of messages.

JsonSerializerSettings

Gets or sets the JSON serialization settings to use when binding to POCOs.

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. The default value is 5 minutes. This does not apply for functions that receive a batch of messages.

MaxConcurrentCalls

Gets or sets the maximum number of concurrent calls to a function. Note each call would be passing a different message. This does not apply for functions that receive a batch of messages. The default is 16 times the return value of Microsoft.Azure.WebJobs.ServiceBus.Utility.GetProcessorCount.

MaxConcurrentSessions

Gets or sets the maximum number of sessions that can be processed concurrently by a function. The default value is 8. This does not apply for functions that receive a batch of messages.

MaxMessageBatchSize

Gets or sets the maximum number of messages that will be passed to each function call. This only applies for functions that receive a batch of messages. The default value is 1000.

PrefetchCount

Gets or sets the PrefetchCount that will be used when receiving messages. The default value is 0.

SessionIdleTimeout

Gets or sets the maximum amount of time to wait for a message to be received for the currently active session. After this time has elapsed, the processor will close the session and attempt to process another session. If not specified, the TryTimeout will be used.

TransportType

The type of protocol and transport that will be used for communicating with the Service Bus service.

WebProxy

The proxy to use for communication over web sockets.

Explicit Interface Implementations

IOptionsFormatter.Format()

Formats the options as JSON objects for display.

Applies to