QueueClient.PeekMessagesAsync メソッド

リファレンス

定義

名前空間:: Azure.Storage.Queues

アセンブリ:: Azure.Storage.Queues.dll

パッケージ:: Azure.Storage.Queues v12.18.0

パッケージ:: Azure.Storage.Queues v12.19.0-beta.1

ソース:: QueueClient.cs

ソース:: QueueClient.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

キューの先頭から 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

適用対象