QueuesOptions Class

  • Reference

Definition

Namespace:
Microsoft.Azure.WebJobs.Host
Assembly:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues.dll
Package:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.3
Package:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.0-beta.1
Source:
QueuesOptions.cs
Source:
QueuesOptions.cs

Represents configuration for QueueTriggerAttribute.

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

Constructors

QueuesOptions()

Initializes a new instance of the QueuesOptions class.

Properties

BatchSize

Gets or sets the number of queue messages to retrieve from the queue (per job method). Must be in range within 1 and 32. The default is 16.

The maximum number of messages processed in parallel by the job is NewBatchThreshold plus BatchSize. These manually configured options aren't used when Dynamic Concurrency is enabled. See Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled for details. When dynamic concurrency is enabled, the host will increase/decrease function concurrency dynamically as needed.

MaxDequeueCount

Gets or sets the number of times to try processing a message before moving it to the poison queue (where possible).
MaxPollingInterval

Gets or sets the longest period of time to wait before checking for a message to arrive when a queue remains empty.
MessageEncoding

Gets or sets a message encoding that determines how queue message body is represented in HTTP requests and responses. The default is Base64.
NewBatchThreshold

Gets or sets the threshold at which a new batch of messages will be fetched (per job method). Must be zero or positive integer. If not set then it defaults to BatchSize/2*processorCount.

The maximum number of messages processed in parallel by the job is NewBatchThreshold plus BatchSize.

VisibilityTimeout

Gets or sets the default message visibility timeout that will be used for messages that fail processing. The default is TimeSpan.Zero. To increase the time delay between retries, increase this value.

Applies to