Share via

ServiceListQueuesOptions interface

  • Reference
Package:
@azure/storage-queue

Options to configure listQueues operation

Extends
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.
includeMetadata

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

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

Inherited Properties

tracingOptions

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

AbortSignalLike

includeMetadata

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

includeMetadata?: boolean

Property Value

boolean

prefix

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

prefix?: string

Property Value

string

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions