ContainerListBlobsOptions interface

Package:

@azure/storage-blob

Options to configure Container - List Blobs operations.

See:

• listBlobsFlat
• listBlobsByHierarchy

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.
includeCopy	Specifies whether metadata related to any current or previous Copy Blob operation should be included in the response.
includeDeleted	Specifies whether soft deleted blobs should be included in the response.
includeDeletedWithVersions	Specifies whether deleted blob with versions be returned in the response.
includeImmutabilityPolicy	Specifies whether blob immutability policy be returned in the response.
includeLegalHold	Specifies whether blob legal hold be returned in the response.
includeMetadata	Specifies whether blob metadata be returned in the response.
includeSnapshots	Specifies whether snapshots should be included in the enumeration. Snapshots are listed from oldest to newest in the response.
includeTags	Specifies whether blob tags be returned in the response.
includeUncommitedBlobs	Specifies whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, be included in the response.
includeVersions	Specifies whether versions should be included in the enumeration. Versions are listed from oldest to newest in the response.
prefix	Filters the results to return only containers 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

includeCopy

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

includeCopy?: boolean

Property Value

boolean

includeDeleted

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

includeDeleted?: boolean

Property Value

boolean

includeDeletedWithVersions

Specifies whether deleted blob with versions be returned in the response.

includeDeletedWithVersions?: boolean

Property Value

boolean

includeImmutabilityPolicy

Specifies whether blob immutability policy be returned in the response.

includeImmutabilityPolicy?: boolean

Property Value

boolean

includeLegalHold

Specifies whether blob legal hold be returned in the response.

includeLegalHold?: boolean

Property Value

boolean

includeMetadata

Specifies whether blob metadata be returned in the response.

includeMetadata?: boolean

Property Value

boolean

includeSnapshots

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

includeSnapshots?: boolean

Property Value

boolean

includeTags

Specifies whether blob tags be returned in the response.

includeTags?: boolean

Property Value

boolean

includeUncommitedBlobs

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

includeUncommitedBlobs?: boolean

Property Value

boolean

includeVersions

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

includeVersions?: boolean

Property Value

boolean

prefix

Filters the results to return only containers 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