ServiceListSharesOptions | @azure/storage-file-share

Options to configure List Shares operation.

export
interface: ServiceListSharesOptions

Hierarchy

CommonOptions
- ServiceListSharesOptions

Index

Properties

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

type: {AbortSignalLike}
memberof: ServiceListSharesOptions

Optional includeMetadata

includeMetadata: undefined | false | true

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

type: {boolean}
memberof: ServiceListSharesOptions

Optional includeSnapshots

includeSnapshots: undefined | false | true

Specifies that share metadata should be returned in the response.

type: {boolean}
memberof: ServiceListSharesOptions

Optional prefix

prefix: undefined | string

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

type: {string}
memberof: ServiceListSharesOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions