MessagesDequeueOptionalParams interface

套件:

@azure/storage-queue

選用參數。

Extends

CommonOptions

屬性

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

繼承的屬性

tracingOptions

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

屬性詳細資料

numberOfMessages

選擇性。 這是非零整數值，可指定從佇列擷取的訊息數目 (32 則為上限)。 如果可見的訊息較少，則會傳回可見的訊息。 根據預設，使用此作業會從佇列擷取單一訊息。

numberOfMessages?: number

屬性值

number

requestId

提供啟用儲存體分析記錄時，由用戶端產生的不透明值，而且在分析記錄中記錄 1 KB 的字元限制。

requestId?: string

屬性值

string

timeoutInSeconds

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

timeoutInSeconds?: number

屬性值

number

visibilityTimeout

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

visibilityTimeout?: number

屬性值

number

繼承的屬性詳細資料

tracingOptions

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

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions