Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostEntity

Package version

Represents a host entity.

Hierarchy

Index

Properties

Optional additionalData

additionalData: undefined | {}

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.

Optional azureID

azureID: undefined | string

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

Optional dnsDomain

dnsDomain: undefined | string

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.

Optional friendlyName

friendlyName: undefined | string

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.

Optional hostName

hostName: undefined | string

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

Optional id

id: undefined | string

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.

Optional isDomainJoined

isDomainJoined: undefined | false | true

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

kind

kind: "Host"

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

Optional name

name: undefined | string

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

Optional netBiosName

netBiosName: undefined | string

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

Optional ntDomain

ntDomain: undefined | string

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

Optional omsAgentID

omsAgentID: undefined | string

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.

Optional osFamily

osFamily: OSFamily

The operating system type.

Optional osVersion

osVersion: undefined | string

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.

Optional systemData

systemData: 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.

Optional type

type: undefined | string

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.

Generated using TypeDoc