Package version:

Interface ContainerListBlobsOptions

Options to configure Container - List Blobs operations.

See:

interface ContainerListBlobsOptions {
    abortSignal?: any;
    includeCopy?: boolean;
    includeDeleted?: boolean;
    includeDeletedWithVersions?: boolean;
    includeImmutabilityPolicy?: boolean;
    includeLegalHold?: boolean;
    includeMetadata?: boolean;
    includeSnapshots?: boolean;
    includeTags?: boolean;
    includeUncommitedBlobs?: boolean;
    includeVersions?: boolean;
    prefix?: string;
    startFrom?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? includeCopy? includeDeleted? includeDeletedWithVersions? includeImmutabilityPolicy? includeLegalHold? includeMetadata? includeSnapshots? includeTags? includeUncommitedBlobs? includeVersions? prefix? startFrom? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalincludeCopy

includeCopy?: boolean

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

OptionalincludeDeleted

includeDeleted?: boolean

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

OptionalincludeDeletedWithVersions

includeDeletedWithVersions?: boolean

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

OptionalincludeImmutabilityPolicy

includeImmutabilityPolicy?: boolean

Specifies whether blob immutability policy be returned in the response.

OptionalincludeLegalHold

includeLegalHold?: boolean

Specifies whether blob legal hold be returned in the response.

OptionalincludeMetadata

includeMetadata?: boolean

Specifies whether blob metadata be returned in the response.

OptionalincludeSnapshots

includeSnapshots?: boolean

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

OptionalincludeTags

includeTags?: boolean

Specifies whether blob tags be returned in the response.

OptionalincludeUncommitedBlobs

includeUncommitedBlobs?: boolean

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

OptionalincludeVersions

includeVersions?: boolean

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

Optionalprefix

prefix?: string

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

OptionalstartFrom

startFrom?: string

Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; For recursive list, multiple entity levels are supported. (Inclusive)

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility