ServiceBusReceiver.PeekMessagesAsync Méthode

Définition

Espace de noms:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Paquet:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

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))

Paramètres

maxMessages

Int32

Nombre maximal de messages qui seront extraits.

fromSequenceNumber

Nullable<Int64>

Numéro de séquence facultatif à partir duquel jeter un coup d’œil au message. Cela correspond à .SequenceNumber

cancellationToken

CancellationToken

Une instance facultative CancellationToken pour signaler la demande d’annulation de l’opération.

Retours

Task<IReadOnlyList<ServiceBusReceivedMessage>>

De IReadOnlyList<T> messages qui ont été aperçus.

Remarques

Contrairement à un message reçu, un message aperçu n’aura pas de jeton de verrouillage associé, et par conséquent, il ne peut pas être Terminé/Abandonné/Différé/Deadlettered/Renewed. En outre, contrairement à ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken), cette méthode extrait même les messages différés (mais pas les messages morts).