CloudQueue.GetMessages メソッド

定義

名前空間:

Microsoft.Azure.Storage.Queue

アセンブリ:

Microsoft.Azure.Storage.Queue.dll

パッケージ:

Microsoft.Azure.Storage.Queue v11.2.3

指定した要求オプションと操作コンテキストを使用して、キューから指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Queue.CloudQueueMessage> GetMessages (int messageCount, TimeSpan? visibilityTimeout = default, Microsoft.Azure.Storage.Queue.QueueRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member GetMessages : int * Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Queue.CloudQueueMessage>
override this.GetMessages : int * Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Queue.CloudQueueMessage>

Public Overridable Function GetMessages (messageCount As Integer, Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional options As QueueRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As IEnumerable(Of CloudQueueMessage)

パラメーター

messageCount

Int32

取得するメッセージの数です。 一度に取得できるメッセージの最大数は 32 です。

visibilityTimeout

Nullable<TimeSpan>

TimeSpan可視性タイムアウト間隔を指定する 。

options

QueueRequestOptions

要求の追加オプションを指定する QueueRequestOptions オブジェクトです。 の場合 null、既定のオプションが要求に適用されます。

operationContext

OperationContext

現在の操作のコンテキストを表す OperationContext オブジェクトです。

戻り値

IEnumerable<CloudQueueMessage>

メッセージの列挙可能なコレクションです。

属性

DoesServiceRequestAttribute