QueueClient.ReceiveMessagesAsync メソッド

定義

名前空間:

Azure.Storage.Queues

アセンブリ:

Azure.Storage.Queues.dll

パッケージ:

Azure.Storage.Queues v12.18.0

オーバーロード

ReceiveMessagesAsync()	キューの先頭から 1 つ以上のメッセージを取得します。 詳細については、「 メッセージを取得します。
ReceiveMessagesAsync(CancellationToken)	キューの先頭から 1 つ以上のメッセージを取得します。 詳細については、「 メッセージを取得します。
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	キューの先頭から 1 つ以上のメッセージを取得します。 詳細については、「 メッセージを取得します。

ReceiveMessagesAsync()

ソース:

QueueClient.cs

キューの先頭から 1 つ以上のメッセージを取得します。

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync ();

abstract member ReceiveMessagesAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>

Public Overridable Function ReceiveMessagesAsync () As Task(Of Response(Of QueueMessage()))

戻り値

Task<Response<QueueMessage[]>>

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

ReceiveMessagesAsync(CancellationToken)

ソース:

QueueClient.cs

キューの先頭から 1 つ以上のメッセージを取得します。

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>

Public Overridable Function ReceiveMessagesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage()))

パラメーター

cancellationToken

CancellationToken

オプション CancellationToken

戻り値

Task<Response<QueueMessage[]>>

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

ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)

ソース:

QueueClient.cs

キューの先頭から 1 つ以上のメッセージを取得します。

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync (int? maxMessages = default, TimeSpan? visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : Nullable<int> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : Nullable<int> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>

Public Overridable Function ReceiveMessagesAsync (Optional maxMessages As Nullable(Of Integer) = Nothing, Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage()))

パラメーター

maxMessages

Nullable<Int32>

任意。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。

visibilityTimeout

Nullable<TimeSpan>

任意。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 既定値は 30 秒です。

cancellationToken

CancellationToken

オプション CancellationToken

戻り値

Task<Response<QueueMessage[]>>

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