Package version:

Interface ServiceListSharesOptions

Options to configure the ShareServiceClient.listShares operation.

interface ServiceListSharesOptions {
    abortSignal?: any;
    includeDeleted?: boolean;
    includeMetadata?: boolean;
    includeSnapshots?: boolean;
    prefix?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? includeDeleted? includeMetadata? includeSnapshots? 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 that share soft deleted should be returned in the response.

OptionalincludeMetadata

includeMetadata?: boolean

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

OptionalincludeSnapshots

includeSnapshots?: boolean

Specifies that share snapshot should be returned in the response.

Optionalprefix

prefix?: string

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

OptionaltracingOptions

tracingOptions?: any

Settings

Member Visibility