MessagesDequeueOptionalParams interface
選擇性參數。
- Extends
-
RequestOptionsBase
屬性
| abort |
可用來中止要求的訊號。 |
| custom |
會在傳送要求之前套用。 |
| number |
自選。 非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。 |
| on |
下載進度引發的回呼。 |
| on |
上傳進度時引發的回呼。 |
| request |
提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。 |
| serializer |
覆寫 XML 剖析/建置行為的選項。 |
| should |
是否應還原串行化 HttpOperationResponse。 如果這是未定義的，則應該還原串行化 HttpOperationResponse。 |
| timeout | 要求在自動終止之前可能需要的毫秒數。
如果要求終止，則會擲回 |
| timeout |
逾時參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。 |
| tracing |
追蹤：建立範圍時所使用的內容。 |
| visibility |
自選。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 預設值為30秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見性逾時可以設定為晚於到期時間的值。 |
屬性詳細資料
abortSignal
可用來中止要求的訊號。
abortSignal?: AbortSignalLike屬性值
AbortSignalLike
customHeaders
會在傳送要求之前套用。
customHeaders?: [key: string]: string屬性值
[key: string]: string
numberOfMessages
自選。 非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。
numberOfMessages?: number屬性值
number
onDownloadProgress
下載進度引發的回呼。
onDownloadProgress?: (progress: TransferProgressEvent) => void屬性值
(progress: TransferProgressEvent) => void
onUploadProgress
上傳進度時引發的回呼。
onUploadProgress?: (progress: TransferProgressEvent) => void屬性值
(progress: TransferProgressEvent) => void
requestId
提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。
requestId?: string屬性值
string
serializerOptions
覆寫 XML 剖析/建置行為的選項。
serializerOptions?: SerializerOptions屬性值
SerializerOptions
shouldDeserialize
是否應還原串行化 HttpOperationResponse。 如果這是未定義的，則應該還原串行化 HttpOperationResponse。
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean屬性值
boolean | (response: HttpOperationResponse) => boolean
timeout
要求在自動終止之前可能需要的毫秒數。
如果要求終止，則會擲回 AbortError。
timeout?: number屬性值
number
timeoutInSeconds
tracingContext
追蹤：建立範圍時所使用的內容。
tracingContext?: Context屬性值
Context
visibilityTimeout
自選。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 預設值為30秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見性逾時可以設定為晚於到期時間的值。
visibilityTimeout?: number屬性值
number
