Process interface
A process resource represents a process running on a machine. The process may be actively monitored, i.e., a Dependency Agent is running on its machine, or discovered, i.e., its existence was inferred by observing the data stream from monitored machines. A process resource represents a pool of actual operating system resources that share command lines and metadata. As the process pool evolves over time, prior versions of the process resource are preserved and available for access. A process is live during an interval of time, if that process is executing during (parts) of that interval
Properties
acceptor |
Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. |
client |
Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. |
details | Process metadata (command line, product name, etc.). |
display |
Name to use for display purposes |
etag | Resource ETAG. |
executable |
The name of the process executable |
group | The name of the product or suite of the process. The group is determined by its executable name, command line, etc. |
hosting | Information about the hosting environment |
id | Resource identifier. NOTE: This property will not be serialized. It can only be populated by the server. |
kind | Polymorphic Discriminator |
machine | Machine hosting this process. |
monitoring |
Specifies whether the process 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. |
role | The inferred role of this process based on its name, command line, etc. Possible values include: 'webServer', 'appServer', 'databaseServer', 'ldapServer', 'smbServer' |
start |
UTC date and time when the process started |
timestamp | UTC date and time when this process resource was updated in the system |
type | Resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
user | Information about the account under which the process is executing. |
Property Details
acceptorOf
Present only for a discovered process acting as a server. References the port on which the discovered process is accepting.
acceptorOf?: ResourceReferenceUnion
Property Value
clientOf
Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of.
clientOf?: ResourceReferenceUnion
Property Value
details
Process metadata (command line, product name, etc.).
details?: ProcessDetails
Property Value
displayName
Name to use for display purposes
displayName?: string
Property Value
string
etag
Resource ETAG.
etag?: string
Property Value
string
executableName
The name of the process executable
executableName?: string
Property Value
string
group
The name of the product or suite of the process. The group is determined by its executable name, command line, etc.
group?: string
Property Value
string
hosting
Information about the hosting environment
hosting?: ProcessHostingConfigurationUnion
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: "process"
Property Value
"process"
machine
Machine hosting this process.
machine?: ResourceReferenceUnion
Property Value
monitoringState
Specifies whether the process 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
role
The inferred role of this process based on its name, command line, etc. Possible values include: 'webServer', 'appServer', 'databaseServer', 'ldapServer', 'smbServer'
role?: ProcessRole
Property Value
startTime
UTC date and time when the process started
startTime?: Date
Property Value
Date
timestamp
UTC date and time when this process resource was updated in the system
timestamp?: Date
Property Value
Date
type
Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
user
Information about the account under which the process is executing.
user?: ProcessUser