MessagesEnqueueOptionalParams interface

Package:

@azure/storage-queue

Optional parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	will be applied before the request is sent.
messageTimeToLive	Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For version 2017-07-29 or later, the maximum time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is omitted, the default time-to-live is 7 days.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
requestId	Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
serializerOptions	Options to override XML parsing/building behavior.
shouldDeserialize	Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.
timeout	The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown.
timeoutInSeconds	The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.
tracingContext	Tracing: Context used when creating spans.
visibilityTimeout	Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later. If not specified, the default value is 0. Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. visibilitytimeout should be set to a value smaller than the time-to-live value.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

messageTimeToLive

Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For version 2017-07-29 or later, the maximum time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is omitted, the default time-to-live is 7 days.

messageTimeToLive?: number

Property Value

number

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

requestId

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

requestId?: string

Property Value

string

serializerOptions

Options to override XML parsing/building behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

shouldDeserialize

Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Property Value

boolean | (response: HttpOperationResponse) => boolean

timeout

The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown.

timeout?: number

Property Value

number

timeoutInSeconds

The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.

timeoutInSeconds?: number

Property Value

number

tracingContext

Tracing: Context used when creating spans.

tracingContext?: Context

Property Value

Context

visibilityTimeout

Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later. If not specified, the default value is 0. Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. visibilitytimeout should be set to a value smaller than the time-to-live value.

visibilityTimeout?: number

Property Value

number