Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ServiceListSharesOptions interface
- Package:
- @azure/storage-file-share
Options to configure the listShares operation.
- Extends
Properties
| abortSignal | An implementation of the |
| includeDeleted | Specifies that share soft deleted should be returned in the response. |
| includeMetadata | Specifies that share snapshots should be included in the enumeration. Share Snapshots are listed from oldest to newest in the response. |
| includeSnapshots | Specifies that share snapshot should be returned in the response. |
| prefix | Filters the results to return only entries whose name begins with the specified prefix. |
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?: AbortSignalLikeProperty Value
includeDeleted
Specifies that share soft deleted should be returned in the response.
includeDeleted?: booleanProperty Value
boolean
includeMetadata
Specifies that share snapshots should be included in the enumeration. Share Snapshots are listed from oldest to newest in the response.
includeMetadata?: booleanProperty Value
boolean
includeSnapshots
Specifies that share snapshot should be returned in the response.
includeSnapshots?: booleanProperty Value
boolean
prefix
Filters the results to return only entries whose name begins with the specified prefix.
prefix?: stringProperty Value
string