ContainerListBlobsOptions | @azure/storage-blob

Options to configure Container - List Blobs operations.

See:

export
interface: ContainerListBlobsOptions

Hierarchy

CommonOptions
- ContainerListBlobsOptions

Index

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: ContainerListBlobsOptions

Optional includeCopy

includeCopy: undefined | false | true

Specifies whether metadata related to any current or previous Copy Blob operation should be included in the response.

Optional includeDeleted

includeDeleted: undefined | false | true

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

Optional includeMetadata

includeMetadata: undefined | false | true

Specifies whether blob metadata be returned in the response.

Optional includeSnapshots

includeSnapshots: undefined | false | true

Specifies whether snapshots should be included in the enumeration. Snapshots are listed from oldest to newest in the response

Optional includeUncommitedBlobs

includeUncommitedBlobs: undefined | false | true

Specifies whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, be included in the response.

Optional prefix

prefix: undefined | string

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

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.