QueuePeekMessagesOptions interface
Options to configure peekMessages operation
- Extends
Properties
abort |
An implementation of the |
Inherited Properties
number |
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. |
request |
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. |
timeout |
The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations. |
tracing |
Options to configure spans created when tracing is enabled. |
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
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 MessagesPeekOptionalParams.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 MessagesPeekOptionalParams.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 MessagesPeekOptionalParams.timeoutInSeconds
tracingOptions
Options to configure spans created when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From CommonOptions.tracingOptions