ListModelsOptions interface

Package:

@azure/digital-twins-core

Optional parameters.

Extends

OperationOptions

Properties

dependenciesFor	If specified, only return the set of the specified models along with their dependencies. If omitted, all models are retrieved.
includeModelDefinition	When true the model definition will be returned as part of the result.
resultsPerPage	The maximum number of items to retrieve per request. The server may choose to return less than the requested number.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
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.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

dependenciesFor

If specified, only return the set of the specified models along with their dependencies. If omitted, all models are retrieved.

dependenciesFor?: string[]

Property Value

string[]

includeModelDefinition

When true the model definition will be returned as part of the result.

includeModelDefinition?: boolean

Property Value

boolean

resultsPerPage

The maximum number of items to retrieve per request. The server may choose to return less than the requested number.

resultsPerPage?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

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

RawResponseCallback

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions