ResourceListingOptions interface
Options shared by server-driven resource listing operations.
- Extends
Properties
| page |
The maximum number of resources to return in one service page. |
| search | A string used to narrow the listing. |
| search |
Specifies how |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| tracing |
Options used when tracing is enabled. |
Property Details
pageSize
The maximum number of resources to return in one service page.
pageSize?: number
Property Value
number
search
A string used to narrow the listing.
search?: string
Property Value
string
searchType
Specifies how search is interpreted. Currently only prefix is supported.
searchType?: string
Property Value
string
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallback
Property Value
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From OperationOptions.tracingOptions