ServiceListQueuesOptions | @azure/storage-queue

Options to configure QueueServiceClient.listQueues operation

export
interface: ServiceListQueuesOptions

Hierarchy

CommonOptions
- ServiceListQueuesOptions

Index

Properties

abortSignal
includeMetadata
prefix
tracingOptions

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

type: {AbortSignalLike}
memberof: ServiceListQueuesOptions

Optional includeMetadata

includeMetadata: undefined | false | true

Specifies whether the queue's metadata be returned as part of the response body.

Optional prefix

prefix: undefined | string

Filters the results to return only queues whose name begins with the specified prefix.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.