ServiceListSharesSegmentOptions | @azure/storage-file-share

Options to configure Share - List Shares Segment operations.

See:

{@link ShareServiceClient.listSegments}
{@link ShareServiceClient.listItems}
{@link ShareServiceClient.listSharesSegment}

Hierarchy

CommonOptions
- ServiceListSharesSegmentOptions

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.

Optional include

include: ListSharesIncludeType[]

Include this parameter to specify one or more datasets to include in the response.

Optional maxResults

maxResults: undefined | number

Specifies the maximum number of entries to return. If the request does not specify maxResults, or specifies a value greater than 5,000, the server will return up to 5,000 items.

Optional prefix

prefix: undefined | string

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

Optional tracingOptions

tracingOptions: OperationTracingOptions