Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IoTDeviceEntityProperties

Package version

IoTDevice entity property bag.

Hierarchy

Index

Properties

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 deviceId

deviceId: undefined | string

The ID of the IoT Device in the IoT Hub NOTE: This property will not be serialized. It can only be populated by the server.

Optional deviceName

deviceName: undefined | string

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

Optional deviceSubType

deviceSubType: undefined | string

The subType of the device ('PLC', 'HMI', 'EWS', etc.) NOTE: This property will not be serialized. It can only be populated by the server.

Optional deviceType

deviceType: undefined | string

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

Optional edgeId

edgeId: undefined | string

The ID of the edge device NOTE: This property will not be serialized. It can only be populated by the server.

Optional firmwareVersion

firmwareVersion: undefined | string

The firmware version of the device 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 hostEntityId

hostEntityId: undefined | string

The Host entity id of this device NOTE: This property will not be serialized. It can only be populated by the server.

Optional importance

importance: DeviceImportance

Device importance, determines if the device classified as 'crown jewel'

Optional iotHubEntityId

iotHubEntityId: undefined | string

The AzureResource entity id of the IoT Hub NOTE: This property will not be serialized. It can only be populated by the server.

Optional iotSecurityAgentId

iotSecurityAgentId: undefined | string

The ID of the security agent running on the device NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipAddressEntityId

ipAddressEntityId: undefined | string

The IP entity if of this device NOTE: This property will not be serialized. It can only be populated by the server.

Optional isAuthorized

isAuthorized: undefined | false | true

Determines whether the device classified as authorized device NOTE: This property will not be serialized. It can only be populated by the server.

Optional isProgramming

isProgramming: undefined | false | true

Determines whether the device classified as programming device NOTE: This property will not be serialized. It can only be populated by the server.

Optional isScanner

isScanner: undefined | false | true

Is the device classified as a scanner device NOTE: This property will not be serialized. It can only be populated by the server.

Optional macAddress

macAddress: undefined | string

The MAC address of the device NOTE: This property will not be serialized. It can only be populated by the server.

Optional model

model: undefined | string

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

Optional nicEntityIds

nicEntityIds: string[]

A list of Nic entity ids of the IoTDevice entity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operatingSystem

operatingSystem: undefined | string

The operating system of the device NOTE: This property will not be serialized. It can only be populated by the server.

Optional owners

owners: string[]

A list of owners of the IoTDevice entity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional protocols

protocols: string[]

A list of protocols of the IoTDevice entity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional purdueLayer

purdueLayer: undefined | string

The Purdue Layer of the device NOTE: This property will not be serialized. It can only be populated by the server.

Optional sensor

sensor: undefined | string

The sensor the device is monitored by NOTE: This property will not be serialized. It can only be populated by the server.

Optional serialNumber

serialNumber: undefined | string

The serial number of the device NOTE: This property will not be serialized. It can only be populated by the server.

Optional site

site: undefined | string

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

Optional source

source: undefined | string

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

Optional threatIntelligence

threatIntelligence: ThreatIntelligence[]

A list of TI contexts attached to the IoTDevice entity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vendor

vendor: undefined | string

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

Optional zone

zone: undefined | string

The zone location of the device within a site NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc