MessagesEnqueueOptionalParams interface
選用參數。
- Extends
屬性
message |
選擇性。 指定訊息之存留時間的間隔 (以秒為單位)。 在 2017-07-29 版之前,允許的最大存留時間是 7 天。 針對 2017-07-29 版或更新版本,存留時間上限可以是任何正數,以及 -1,表示訊息不會過期。 如果省略此參數,預設存留時間為 7 天。 |
request |
提供啟用儲存體分析記錄時,由用戶端產生的不透明值,而且在分析記錄中記錄 1 KB 的字元限制。 |
timeout |
逾時參數是以秒為單位表示。 如需詳細資訊,請參閱 設定佇列服務作業的逾時。 |
visibility |
選擇性。 如果指定,必須使用 x-ms-version of 2011-08-18 或更新版本提出要求。 若未指定,預設值是 0。 指定相對於伺服器時間的新可見度逾時值 (以秒為單位)。 此新值必須大於或等於 0,而且不得超過 7 天。 訊息的可見度逾時不可以設為晚於到期時間的值。 visibilitytimeout 應設定為小於存留時間值的值。 |
繼承的屬性
tracing |
啟用追蹤時所建立範圍的選項。 |
屬性詳細資料
messageTimeToLive
選擇性。 指定訊息之存留時間的間隔 (以秒為單位)。 在 2017-07-29 版之前,允許的最大存留時間是 7 天。 針對 2017-07-29 版或更新版本,存留時間上限可以是任何正數,以及 -1,表示訊息不會過期。 如果省略此參數,預設存留時間為 7 天。
messageTimeToLive?: number
屬性值
number
requestId
提供啟用儲存體分析記錄時,由用戶端產生的不透明值,而且在分析記錄中記錄 1 KB 的字元限制。
requestId?: string
屬性值
string
timeoutInSeconds
visibilityTimeout
選擇性。 如果指定,必須使用 x-ms-version of 2011-08-18 或更新版本提出要求。 若未指定,預設值是 0。 指定相對於伺服器時間的新可見度逾時值 (以秒為單位)。 此新值必須大於或等於 0,而且不得超過 7 天。 訊息的可見度逾時不可以設為晚於到期時間的值。 visibilitytimeout 應設定為小於存留時間值的值。
visibilityTimeout?: number
屬性值
number
繼承的屬性詳細資料
tracingOptions
啟用追蹤時所建立範圍的選項。
tracingOptions?: OperationTracingOptions