Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

QueueAttribute Class

Definition

Namespace:
Microsoft.Azure.WebJobs
Assembly:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues.dll
Package:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.8
Package:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.0-beta.1
Source:
QueueAttribute.cs
Source:
QueueAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attribute used to bind a parameter to an Azure Queue.

[Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.StorageAccountAttribute))]
[Microsoft.Azure.WebJobs.Description.Binding]
[System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]
public class QueueAttribute : Attribute, Microsoft.Azure.WebJobs.IConnectionProvider
[<Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.StorageAccountAttribute))>]
[<Microsoft.Azure.WebJobs.Description.Binding>]
[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)>]
type QueueAttribute = class
 inherit Attribute
 interface IConnectionProvider
Public Class QueueAttribute
Inherits Attribute
Implements IConnectionProvider
Inheritance
QueueAttribute
Attributes
Microsoft.Azure.WebJobs.ConnectionProviderAttribute Microsoft.Azure.WebJobs.Description.BindingAttribute AttributeUsageAttribute
Implements
Microsoft.Azure.WebJobs.IConnectionProvider

Remarks

The method parameter type can be one of the following:

  • QueueClient
  • QueueMessage (out parameter)
  • String (out parameter)
  • byte[] (out parameter)
  • BinaryData (out parameter)
  • A user-defined type (out parameter, serialized as JSON)
  • Microsoft.Azure.WebJobs.ICollector`1 of these types (to enqueue multiple messages via Microsoft.Azure.WebJobs.ICollector`1.Add(`0)
  • Microsoft.Azure.WebJobs.IAsyncCollector`1 of these types (to enqueue multiple messages via Microsoft.Azure.WebJobs.IAsyncCollector`1.AddAsync(`0,System.Threading.CancellationToken)

By default the extension Base64-encodes outgoing messages. This behavior can be changed by setting MessageEncoding. For example, to configure Azure Functions to perform no base64 encoding/decoding, specify the following in host.json. 

"extensions": {
 "queues": {
 "messageEncoding": "none"
 }
}

Constructors

Name Description
QueueAttribute(String)

Initializes a new instance of the QueueAttribute class.

Properties

Name Description
Connection

Gets or sets the app setting name that contains the Azure Storage connection string.
QueueName

Gets the name of the queue to which to bind.

Applies to

Feedback

Was this page helpful?