ExamplesListOptionalParams interface
Optional Parameters.
- Extends
Properties
enable |
Toggles nested/flat format. Default value: false. |
skip | The number of entries to skip. Default value is 0. Default value: 0. |
take | The number of entries to return. Maximum page size is 500. Default is 100. Default value: 100. |
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
enableNestedChildren
Toggles nested/flat format. Default value: false.
enableNestedChildren?: boolean
Property Value
boolean
skip
The number of entries to skip. Default value is 0. Default value: 0.
skip?: number
Property Value
number
take
The number of entries to return. Maximum page size is 500. Default is 100. Default value: 100.
take?: 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