Share via

DirectoryListHandlesSegmentOptions interface

  • Reference
Package:
@azure/storage-file-share

Options to configure Directory - List Handles Segment operations.

See:

  • <xref:ShareDirectoryClient.listHandlesSegment>
  • <xref:ShareDirectoryClient.iterateHandleSegments>
  • <xref:ShareDirectoryClient.listHandleItems>
Extends
CommonOptions

Properties

abortSignal

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.
maxResults

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.
recursive

Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.

Inherited Properties

tracingOptions

Property Details

abortSignal

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.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

maxResults

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.

maxResults?: number

Property Value

number

recursive

Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.

recursive?: boolean

Property Value

boolean

Inherited Property Details

tracingOptions 

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions