Port interface

A port resource represents a server port on a machine. The port 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 port is live during an interval of time, if that port had associated activity during (parts) of that interval.

Properties

displayName

Name to use for display purposes.

etag

Resource ETAG.

id

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

ipAddress

IP address associated with the port. At present only IPv4 addresses are supported.

kind

Polymorphic Discriminator

machine

Machine hosting this port.

monitoringState

Specifies whether the port 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.

portNumber

Port number.

type

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

Property Details

displayName

Name to use for display purposes.

displayName?: string

Property Value

string

etag

Resource ETAG.

etag?: string

Property Value

string

id

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

id?: string

Property Value

string

ipAddress

IP address associated with the port. At present only IPv4 addresses are supported.

ipAddress?: string

Property Value

string

kind

Polymorphic Discriminator

kind: "port"

Property Value

"port"

machine

Machine hosting this port.

machine?: ResourceReferenceUnion

Property Value

monitoringState

Specifies whether the port 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

portNumber

Port number.

portNumber?: number

Property Value

number

type

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

type?: string

Property Value

string