MessagesEnqueueOptionalParams interface

套件:

@azure/storage-queue

選擇性參數。

Extends

CommonOptions

屬性

messageTimeToLive	自選。 指定訊息的存留時間間隔，以秒為單位。 在 2017-07-29 版之前，允許存留時間上限為 7 天。 針對 2017-07-29 版或更新版本，存留時間上限可以是任何正數，以及指出訊息未過期的 -1。 如果省略此參數，預設存留時間是 7 天。
requestId	提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。
timeoutInSeconds	逾時參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。
visibilityTimeout	自選。 如果指定，則必須使用 x-ms-version of 2011-08-18 或更新版本提出要求。 如果未指定，預設值為 0。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 新值必須大於或等於0，且不能大於7天。 訊息的可見性逾時不能設定為晚於到期時間的值。 visibilitytimeout 應該設定為小於存留時間值的值。

繼承的屬性

tracingOptions

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

屬性詳細資料

messageTimeToLive

自選。 指定訊息的存留時間間隔，以秒為單位。 在 2017-07-29 版之前，允許存留時間上限為 7 天。 針對 2017-07-29 版或更新版本，存留時間上限可以是任何正數，以及指出訊息未過期的 -1。 如果省略此參數，預設存留時間是 7 天。

messageTimeToLive?: number

屬性值

number

requestId

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

requestId?: string

屬性值

string

timeoutInSeconds

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

timeoutInSeconds?: number

屬性值

number

visibilityTimeout

自選。 如果指定，則必須使用 x-ms-version of 2011-08-18 或更新版本提出要求。 如果未指定，預設值為 0。 指定相對於伺服器時間的新可見度逾時值，以秒為單位。 新值必須大於或等於0，且不能大於7天。 訊息的可見性逾時不能設定為晚於到期時間的值。 visibilitytimeout 應該設定為小於存留時間值的值。

visibilityTimeout?: number

屬性值

number

繼承的屬性詳細資料

tracingOptions

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

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions