ApiListByServiceOptionalParams interface
Optional parameters.
- Extends
Properties
expand |
Include full ApiVersionSet resource in response |
filter | | Field | Usage | Supported operators | Supported functions | |
skip | Number of records to skip. |
tags | Include tags in the response. |
top | Number of records to return. |
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. |
serializer |
Options to override serialization/de-serialization behavior. |
tracing |
Options used when tracing is enabled. |
Property Details
expandApiVersionSet
Include full ApiVersionSet resource in response
expandApiVersionSet?: boolean
Property Value
boolean
filter
| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
filter?: string
Property Value
string
skip
Number of records to skip.
skip?: number
Property Value
number
tags
Include tags in the response.
tags?: string
Property Value
string
top
Number of records to return.
top?: number
Property Value
number
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From coreClient.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 coreClient.OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From coreClient.OperationOptions.requestOptions
serializerOptions
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptions
Property Value
Inherited From coreClient.OperationOptions.serializerOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From coreClient.OperationOptions.tracingOptions