ServiceBusReceiveActions.PeekMessagesAsync Método

Referência

Definição

Namespace:: Microsoft.Azure.WebJobs.ServiceBus

Assembly:: Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Pacote:: Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.1

Origem:: ServiceBusReceiveActions.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> PeekMessagesAsync (int maxMessages, long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>

Public Overridable Function PeekMessagesAsync (maxMessages As Integer, Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))

Parâmetros

maxMessages: Int32

O número máximo de mensagens que serão buscadas.

fromSequenceNumber: Nullable<Int64>

Um número de sequência opcional de onde espiar a mensagem. Isso corresponde ao SequenceNumber.

cancellationToken: CancellationToken

Uma instância opcional CancellationToken para sinalizar a solicitação para cancelar a operação.

Retornos

Task<IReadOnlyList<ServiceBusReceivedMessage>>

Um IReadOnlyList<T> de mensagens que foram espiadas.

Comentários

Ao contrário de uma mensagem recebida, uma mensagem espiada não terá um token de bloqueio associado a ela e, portanto, não pode ser Concluída/Abandonada/Adiada/Morta/Renovada. Além disso, ao contrário ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)de , esse método buscará até mesmo mensagens adiadas (mas não mensagens Deadlettered).

Aplica-se a

Compartilhar via