QueuePeekMessagesOptions interface

Options to configure peekMessages operation

Extends

Inherited Properties

abortSignal

Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.

customHeaders

will be applied before the request is sent.

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.

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.

tracingOptions

Options to configure spans created when tracing is enabled.

Inherited Property Details

abortSignal

Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From MessagesPeekOptionalParams.abortSignal

customHeaders

will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From MessagesPeekOptionalParams.customHeaders

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

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From MessagesPeekOptionalParams.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From MessagesPeekOptionalParams.onUploadProgress

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

serializerOptions

Options to override XML parsing/building behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From MessagesPeekOptionalParams.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

Inherited From MessagesPeekOptionalParams.shouldDeserialize

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

Inherited From MessagesPeekOptionalParams.timeout

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

tracingContext

Tracing: Context used when creating spans.

tracingContext?: Context

Property Value

Context

Inherited From MessagesPeekOptionalParams.tracingContext

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions