Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachinesListByWorkspaceOptionalParams

Package version

Optional Parameters.

Hierarchy

  • any
    • MachinesListByWorkspaceOptionalParams

Index

Properties

Optional endTime

endTime: Date

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

Optional live

live: undefined | false | true

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.

Optional startTime

startTime: Date

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

Optional timestamp

timestamp: Date

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.

Optional top

top: undefined | number

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

Generated using TypeDoc