ServiceBusReceiveActions.PeekMessagesAsync Método

Referencia

Definición

Espacio de nombres:: Microsoft.Azure.WebJobs.ServiceBus

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

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

Source:: ServiceBusReceiveActions.cs

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

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

Número máximo de mensajes que se capturarán.

fromSequenceNumber: Nullable<Int64>

Número de secuencia opcional desde donde se va a ver el mensaje. Esto corresponde a SequenceNumber.

cancellationToken: CancellationToken

Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.

Devoluciones

Task<IReadOnlyList<ServiceBusReceivedMessage>>

de IReadOnlyList<T> mensajes que se han inspeccionado.

Comentarios

A diferencia de un mensaje recibido, un mensaje inspeccionado no tendrá un token de bloqueo asociado y, por lo tanto, no puede ser Completado/ Abandonado/Diferido/Fallido/Renovado. Además, a diferencia ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)de , este método capturará incluso mensajes diferidos (pero no mensajes fallidos).

Se aplica a

Compartir a través de