Package version:

Interface ServiceListContainersOptions

Options to configure the BlobServiceClient.listContainers operation.

interface ServiceListContainersOptions {
    abortSignal?: any;
    includeDeleted?: boolean;
    includeMetadata?: boolean;
    includeSystem?: boolean;
    prefix?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? includeDeleted? includeMetadata? includeSystem? prefix? 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.

OptionalincludeDeleted

includeDeleted?: boolean

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

OptionalincludeMetadata

includeMetadata?: boolean

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

OptionalincludeSystem

includeSystem?: boolean

Specifies whether system containers should be included in the response.

Optionalprefix

prefix?: string

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

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility