FileListHandlesSegmentOptions | @azure/storage-file-share

Options to configure File - List Handles Segment operations.

See:

{@link ShareFileClient.listHandlesSegment}
{@link ShareFileClient.iterateHandleSegments}
{@link ShareFileClient.listHandleItems}

Hierarchy

CommonOptions
- FileListHandlesSegmentOptions

Index

Properties

abortSignal
maxPageSize
tracingOptions

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 maxPageSize

maxPageSize: 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 tracingOptions

tracingOptions: OperationTracingOptions