Share via

QueueClient.PeekMessageAsync(CancellationToken) メソッド

  • リファレンス

定義

名前空間:
Azure.Storage.Queues
アセンブリ:
Azure.Storage.Queues.dll
パッケージ:
Azure.Storage.Queues v12.18.0
パッケージ:
Azure.Storage.Queues v12.18.0-beta.2
ソース:
QueueClient.cs
ソース:
QueueClient.cs

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

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>> PeekMessageAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member PeekMessageAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>>
override this.PeekMessageAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>>
Public Overridable Function PeekMessageAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PeekedMessage))

パラメーター

cancellationToken
CancellationToken

オプション CancellationToken

戻り値

Task<Response<PeekedMessage>>

Response<T> ここで、T は です PeekedMessage。 キューにメッセージがない場合は null を返します。

適用対象