QueueReceiveMessageOptions interface

  • Reference
Package:
@azure/storage-queue

Options to configure receiveMessages operation

Extends

MessagesDequeueOptionalParams,CommonOptions

Properties

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

Inherited Properties

numberOfMessages

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation.
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.
timeoutInSeconds

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

Options to configure spans created when tracing is enabled.
visibilityTimeout

Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time.

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited Property Details

numberOfMessages

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation.

numberOfMessages?: number

Property Value

number

Inherited From MessagesDequeueOptionalParams.numberOfMessages

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

Inherited From MessagesDequeueOptionalParams.requestId

timeoutInSeconds

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

timeoutInSeconds?: number

Property Value

number

Inherited From MessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions

visibilityTimeout

Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time.

visibilityTimeout?: number

Property Value

number

Inherited From MessagesDequeueOptionalParams.visibilityTimeout