Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
QueueClient.ReceiveMessagesAsync Method
Definition
- Namespace:
- Azure.Storage.Queues
- Assembly:
- Azure.Storage.Queues.dll
- Package:
- Azure.Storage.Queues v12.27.0
- Package:
- Azure.Storage.Queues v12.27.0-beta.1
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.
Overloads
| Name | Description |
|---|---|
| ReceiveMessagesAsync() |
Retrieves one or more messages from the front of the queue. For more information, see Get Messages. |
| ReceiveMessagesAsync(CancellationToken) |
Retrieves one or more messages from the front of the queue. For more information, see Get Messages. |
| ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken) |
Retrieves one or more messages from the front of the queue. For more information, see Get Messages. |
ReceiveMessagesAsync()
- Source:
- QueueClient.cs
- Source:
- QueueClient.cs
Retrieves one or more messages from the front of the queue.
For more information, see Get Messages.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync();abstract member ReceiveMessagesAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>Public Overridable Function ReceiveMessagesAsync () As Task(Of Response(Of QueueMessage()))Returns
Response<T> where T is an array of QueueMessage
Applies to
ReceiveMessagesAsync(CancellationToken)
- Source:
- QueueClient.cs
- Source:
- QueueClient.cs
Retrieves one or more messages from the front of the queue.
For more information, see Get Messages.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync(System.Threading.CancellationToken cancellationToken = default);abstract member ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>Public Overridable Function ReceiveMessagesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage()))Parameters
- cancellationToken
- CancellationToken
Optional CancellationToken
Returns
Response<T> where T is an array of QueueMessage
Applies to
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)
- Source:
- QueueClient.cs
- Source:
- QueueClient.cs
Retrieves one or more messages from the front of the queue.
For more information, see Get Messages.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync(int? maxMessages = default, TimeSpan? visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReceiveMessagesAsync : Nullable<int> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : Nullable<int> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>Public Overridable Function ReceiveMessagesAsync (Optional maxMessages As Nullable(Of Integer) = Nothing, Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage()))Parameters
Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation.
Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds.
- cancellationToken
- CancellationToken
Optional CancellationToken
Returns
Response<T> where T is an array of QueueMessage
Applies to
Azure SDK for .NET
Feedback
Was this page helpful?