ServiceListContainersOptions interface

Package:

@azure/storage-blob

Options to configure the <xref:BlobServiceClient.listContainers> 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.
includeDeleted	Specifies whether soft deleted containers should be included in the response.
includeMetadata	Specifies whether the container's metadata should be returned as part of the response body.
prefix	Filters the results to return only containers whose name begins with the specified prefix.
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

includeDeleted

Specifies whether soft deleted containers should be included in the response.

includeDeleted?: boolean

Property Value

boolean

includeMetadata

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

includeMetadata?: boolean

Property Value

boolean

prefix

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

prefix?: string

Property Value

string

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions