MessagesDequeueOptionalParams interface

套件:

@azure/storage-queue

選擇性參數。

Extends

CommonOptions

屬性

numberOfMessages	自選。 非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。
requestId	提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。
timeoutInSeconds	逾時參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。
visibilityTimeout	自選。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 預設值為30秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見性逾時可以設定為晚於到期時間的值。

繼承的屬性

tracingOptions

設定啟用追蹤時所建立範圍的選項。

屬性詳細資料

numberOfMessages

自選。 非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。

numberOfMessages?: number

屬性值

number

requestId

提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。

requestId?: string

屬性值

string

timeoutInSeconds

逾時參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。

timeoutInSeconds?: number

屬性值

number

visibilityTimeout

自選。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 預設值為30秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見性逾時可以設定為晚於到期時間的值。

visibilityTimeout?: number

屬性值

number

繼承的屬性詳細資料

tracingOptions

設定啟用追蹤時所建立範圍的選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions