Share via

HostEntity interface

  • Reference
Package:
@azure/arm-securityinsight

Represents a host entity.

Extends
Entity

Properties

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.
azureID

The azure resource id of the VM. NOTE: This property will not be serialized. It can only be populated by the server.
dnsDomain

The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain NOTE: This property will not be serialized. It can only be populated by the server.
friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.
hostName

The hostname without the domain suffix. NOTE: This property will not be serialized. It can only be populated by the server.
isDomainJoined

Determines whether this host belongs to a domain. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Polymorphic discriminator, which specifies the different types this object can be
netBiosName

The host name (pre-windows2000). NOTE: This property will not be serialized. It can only be populated by the server.
ntDomain

The NT domain that this host belongs to. NOTE: This property will not be serialized. It can only be populated by the server.
omsAgentID

The OMS agent id, if the host has OMS agent installed. NOTE: This property will not be serialized. It can only be populated by the server.
osFamily

The operating system type.
osVersion

A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.

additionalData?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

azureID

The azure resource id of the VM. NOTE: This property will not be serialized. It can only be populated by the server.

azureID?: string

Property Value

string

dnsDomain

The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain NOTE: This property will not be serialized. It can only be populated by the server.

dnsDomain?: string

Property Value

string

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName?: string

Property Value

string

hostName

The hostname without the domain suffix. NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

isDomainJoined

Determines whether this host belongs to a domain. NOTE: This property will not be serialized. It can only be populated by the server.

isDomainJoined?: boolean

Property Value

boolean

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "Host"

Property Value

"Host"

netBiosName

The host name (pre-windows2000). NOTE: This property will not be serialized. It can only be populated by the server.

netBiosName?: string

Property Value

string

ntDomain

The NT domain that this host belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

ntDomain?: string

Property Value

string

omsAgentID

The OMS agent id, if the host has OMS agent installed. NOTE: This property will not be serialized. It can only be populated by the server.

omsAgentID?: string

Property Value

string

osFamily

The operating system type.

osFamily?: OSFamily

Property Value

OSFamily

osVersion

A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration NOTE: This property will not be serialized. It can only be populated by the server.

osVersion?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Entity.id

name

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

name?: string

Property Value

string

Inherited From Entity.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Entity.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Entity.type