Share via

MachinesListProcessesOptionalParams interface

Package:
@azure/arm-servicemap

Optional Parameters.

Extends
RequestOptionsBase

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. Default value: true.
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 all process resource. Only applies when live=false. When not specified, the service uses DateTime.UtcNow.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
customHeaders

User defined custom request headers that will be applied before the request is sent.
onDownloadProgress

Callback which fires upon download progress.
onUploadProgress

Callback which fires upon upload progress.
timeout

The number of milliseconds a request can take before automatically being terminated.

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. Default value: true.

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 all process resource. Only applies when live=false. When not specified, the service uses DateTime.UtcNow.

timestamp?: Date

Property Value

Date

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

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