ServiceBusReceiveActions.PeekMessagesAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.WebJobs.ServiceBus

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

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

Source:: ServiceBusReceiveActions.cs

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

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

S’applique à

Partager via