Machine interface

A machine resource represents a discovered computer system. It can be monitored, i.e., a Dependency Agent is running on it, or discovered, i.e., its existence was inferred by observing the data stream from monitored machines. As machines change, prior versions of the machine resource are preserved and available for access. A machine is live during an interval of time, if either its Dependency Agent has reported data during (parts) of that interval, or a Dependency agent running on other machines has reported activity associated with the machine.

Properties

agent

Dependency Agent configuration.

bootTime

UTC date and time when the machine last booted

computerName

Name of the machine, e.g., server

displayName

Name to use for display purposes

etag

Resource ETAG.

fullyQualifiedDomainName

Fully-qualified name of the machine, e.g., server.company.com

hosting

Hosting-related configuration. Present if hosting information is discovered for the VM.

hypervisor

Hypervisor-related configuration. Present only when 'virtualizationState' is hypervisor.

id

Resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

kind

Polymorphic Discriminator

monitoringState

Specifies whether the machine is actively monitored or discovered. Possible values include: 'monitored', 'discovered'

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

networking

Network configuration (ips, gateways, dns, etc.)

operatingSystem

Operating system information.

resources

Machine resources (memory, cpu, etc.).

timestamp

UTC date and time when this resource was updated in the system.

timezone

Timezone of the machine.

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

virtualizationState

Specifies whether the machine is virtualized. Possible values include: 'unknown', 'physical', 'virtual', 'hypervisor'

virtualMachine

Virtualization-related configuration. Present only when virtualizationState is virtual.

Property Details

agent

Dependency Agent configuration.

agent?: AgentConfiguration

Property Value

bootTime

UTC date and time when the machine last booted

bootTime?: Date

Property Value

Date

computerName

Name of the machine, e.g., server

computerName?: string

Property Value

string

displayName

Name to use for display purposes

displayName?: string

Property Value

string

etag

Resource ETAG.

etag?: string

Property Value

string

fullyQualifiedDomainName

Fully-qualified name of the machine, e.g., server.company.com

fullyQualifiedDomainName?: string

Property Value

string

hosting

Hosting-related configuration. Present if hosting information is discovered for the VM.

hosting?: HostingConfigurationUnion

Property Value

hypervisor

Hypervisor-related configuration. Present only when 'virtualizationState' is hypervisor.

hypervisor?: HypervisorConfiguration

Property Value

id

Resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

kind

Polymorphic Discriminator

kind: "machine"

Property Value

"machine"

monitoringState

Specifies whether the machine is actively monitored or discovered. Possible values include: 'monitored', 'discovered'

monitoringState?: MonitoringState

Property Value

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

networking

Network configuration (ips, gateways, dns, etc.)

networking?: NetworkConfiguration

Property Value

operatingSystem

Operating system information.

operatingSystem?: OperatingSystemConfiguration

Property Value

resources

Machine resources (memory, cpu, etc.).

resources?: MachineResourcesConfiguration

Property Value

timestamp

UTC date and time when this resource was updated in the system.

timestamp?: Date

Property Value

Date

timezone

Timezone of the machine.

timezone?: Timezone

Property Value

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

virtualizationState

Specifies whether the machine is virtualized. Possible values include: 'unknown', 'physical', 'virtual', 'hypervisor'

virtualizationState?: VirtualizationState

Property Value

virtualMachine

Virtualization-related configuration. Present only when virtualizationState is virtual.

virtualMachine?: VirtualMachineConfiguration

Property Value