QueueClient.PeekMessagesAsync メソッド

定義

名前空間:

Azure.Storage.Queues

アセンブリ:

Azure.Storage.Queues.dll

パッケージ:

Azure.Storage.Queues v12.18.0

ソース:

QueueClient.cs

キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。

詳細については、「 メッセージをピークします。

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

パラメーター

maxMessages

Nullable<Int32>

省略可能。 キューから表示するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 既定では、この操作でキューから 1 件のメッセージが表示されます。

cancellationToken

CancellationToken

オプション CancellationToken

戻り値

Task<Response<PeekedMessage[]>>

Response<T> ここで、T は の配列です PeekedMessage