HostEntity interface
Represents a host entity.
- Extends
Properties
| additional |
A bag of custom fields that should be part of the entity and will be presented to the user. |
| azureID | The azure resource id of the VM. |
| dns |
The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain |
| friendly |
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. |
| host |
The hostname without the domain suffix. |
| is |
Determines whether this host belongs to a domain. |
| kind | The kind of the entity. |
| net |
The host name (pre-windows2000). |
| nt |
The NT domain that this host belongs to. |
| oms |
The OMS agent id, if the host has OMS agent installed. |
| os |
The operating system type. |
| os |
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 |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
additionalData
A bag of custom fields that should be part of the entity and will be presented to the user.
additionalData?: Record<string, any>Property Value
Record<string, any>
azureID
The azure resource id of the VM.
azureID?: stringProperty Value
string
dnsDomain
The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain
dnsDomain?: stringProperty 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.
friendlyName?: stringProperty Value
string
hostName
The hostname without the domain suffix.
hostName?: stringProperty Value
string
isDomainJoined
Determines whether this host belongs to a domain.
isDomainJoined?: booleanProperty Value
boolean
kind
The kind of the entity.
kind: "Host"Property Value
"Host"
netBiosName
The host name (pre-windows2000).
netBiosName?: stringProperty Value
string
ntDomain
The NT domain that this host belongs to.
ntDomain?: stringProperty Value
string
omsAgentID
The OMS agent id, if the host has OMS agent installed.
omsAgentID?: stringProperty Value
string
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
osVersion?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From Entity.id
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From Entity.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From Entity.type
