Share via

MachinesListByWorkspaceNextOptionalParams interface

  • Reference
Package:
@azure/arm-servicemap

Optional parameters.

Extends
OperationOptions

Properties

endTime

UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
live

Specifies whether to return live resources (true) or inventory resources (false). Defaults to true. When retrieving live resources, the start time (startTime) and end time (endTime) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (timestamp) parameter can be specified to return the version of each resource closest (not-after) that timestamp.
startTime

UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
timestamp

UTC date and time specifying a time instance relative to which to evaluate each machine resource. Only applies when live=false. When not specified, the service uses DateTime.UtcNow.
top

Page size to use. When not specified, the default page size is 100 records.

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

endTime

UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow

endTime?: Date

Property Value

Date

live

Specifies whether to return live resources (true) or inventory resources (false). Defaults to true. When retrieving live resources, the start time (startTime) and end time (endTime) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (timestamp) parameter can be specified to return the version of each resource closest (not-after) that timestamp.

live?: boolean

Property Value

boolean

startTime

UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m

startTime?: Date

Property Value

Date

timestamp

UTC date and time specifying a time instance relative to which to evaluate each machine resource. Only applies when live=false. When not specified, the service uses DateTime.UtcNow.

timestamp?: Date

Property Value

Date

top

Page size to use. When not specified, the default page size is 100 records.

top?: 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