FileListHandlesOptionalParams interface
Optional Parameters.
- Extends
Properties
marker | A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. |
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. |
sharesnapshot | The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. |
timeout |
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
custom |
User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
marker
A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.
marker?: string
Property Value
string
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
sharesnapshot
The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
sharesnapshot?: string
Property Value
string
timeoutParameter
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
timeoutParameter?: number
Property Value
number
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From msRest.RequestOptionsBase.abortSignal
customHeaders
User defined custom request headers that will be applied before the request is sent.
customHeaders?: {[key: string]: string}
Property Value
{[key: string]: string}
Inherited From msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From msRest.RequestOptionsBase.onUploadProgress
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: number
Property Value
number
Inherited From msRest.RequestOptionsBase.timeout
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for