QueueClient.PeekMessagesAsync Método

Definição

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Pacote:

Azure.Storage.Queues v12.18.0

Origem:

QueueClient.cs

Recupera uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem.

Para obter mais informações, consulte Espiar Mensagens.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>> PeekMessagesAsync (int? maxMessages = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessagesAsync : Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>>
override this.PeekMessagesAsync : Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>>

Public Overridable Function PeekMessagesAsync (Optional maxMessages As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PeekedMessage()))

Parâmetros

maxMessages

Nullable<Int32>

Opcional. Um valor inteiro diferente de zero que especifica o número de mensagens a serem inspecionadas da fila, até um máximo de 32. Por padrão, uma única mensagem é inspecionada da fila com essa operação.

cancellationToken

CancellationToken

Opcional CancellationToken

Retornos

Task<Response<PeekedMessage[]>>

Response<T> em que T é uma matriz de PeekedMessage