QueueReceiveMessageOptions interface
設定 receiveMessages 作業的選項
- Extends
屬性
| abort |
|
繼承的屬性
| number |
自選。 非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。 |
| request |
提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。 |
| timeout |
逾時參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。 |
| tracing |
設定啟用追蹤時所建立範圍的選項。 |
| visibility |
自選。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 預設值為30秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見性逾時可以設定為晚於到期時間的值。 |
屬性詳細資料
abortSignal
AbortSignalLike 介面的實作，以發出取消作業的要求。
例如，使用 @azure/abort-controller 來建立 AbortSignal。
abortSignal?: AbortSignalLike屬性值
繼承的屬性詳細資料
numberOfMessages
自選。 非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。
numberOfMessages?: number屬性值
number
requestId
提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。
requestId?: string屬性值
string
timeoutInSeconds
tracingOptions
設定啟用追蹤時所建立範圍的選項。
tracingOptions?: OperationTracingOptions屬性值
visibilityTimeout
自選。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 預設值為30秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見性逾時可以設定為晚於到期時間的值。
visibilityTimeout?: number屬性值
number