IoTDeviceEntity interface
Represents an IoT device entity.
- Extends
Properties
| additional |
A bag of custom fields that should be part of the entity and will be presented to the user. |
| device |
The ID of the IoT Device in the IoT Hub |
| device |
The friendly name of the device |
| device |
The subType of the device ('PLC', 'HMI', 'EWS', etc.) |
| device |
The type of the device |
| edge |
The ID of the edge device |
| firmware |
The firmware version of the device |
| 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 Host entity id of this device |
| importance | Device importance, determines if the device classified as 'crown jewel' |
| iot |
The AzureResource entity id of the IoT Hub |
| iot |
The ID of the security agent running on the device |
| ip |
The IP entity if of this device |
| is |
Determines whether the device classified as authorized device |
| is |
Determines whether the device classified as programming device |
| is |
Is the device classified as a scanner device |
| kind | The kind of the entity. |
| mac |
The MAC address of the device |
| model | The model of the device |
| nic |
A list of Nic entity ids of the IoTDevice entity. |
| operating |
The operating system of the device |
| owners | A list of owners of the IoTDevice entity. |
| protocols | A list of protocols of the IoTDevice entity. |
| purdue |
The Purdue Layer of the device |
| sensor | The sensor the device is monitored by |
| serial |
The serial number of the device |
| site | The site of the device |
| source | The source of the device |
| threat |
A list of TI contexts attached to the IoTDevice entity. |
| vendor | The vendor of the device |
| zone | The zone location of the device within a site |
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>
deviceId
The ID of the IoT Device in the IoT Hub
deviceId?: stringProperty Value
string
deviceName
The friendly name of the device
deviceName?: stringProperty Value
string
deviceSubType
The subType of the device ('PLC', 'HMI', 'EWS', etc.)
deviceSubType?: stringProperty Value
string
deviceType
The type of the device
deviceType?: stringProperty Value
string
edgeId
The ID of the edge device
edgeId?: stringProperty Value
string
firmwareVersion
The firmware version of the device
firmwareVersion?: 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
hostEntityId
The Host entity id of this device
hostEntityId?: stringProperty Value
string
importance
Device importance, determines if the device classified as 'crown jewel'
importance?: stringProperty Value
string
iotHubEntityId
The AzureResource entity id of the IoT Hub
iotHubEntityId?: stringProperty Value
string
iotSecurityAgentId
The ID of the security agent running on the device
iotSecurityAgentId?: stringProperty Value
string
ipAddressEntityId
The IP entity if of this device
ipAddressEntityId?: stringProperty Value
string
isAuthorized
Determines whether the device classified as authorized device
isAuthorized?: booleanProperty Value
boolean
isProgramming
Determines whether the device classified as programming device
isProgramming?: booleanProperty Value
boolean
isScanner
Is the device classified as a scanner device
isScanner?: booleanProperty Value
boolean
kind
The kind of the entity.
kind: "IoTDevice"Property Value
"IoTDevice"
macAddress
The MAC address of the device
macAddress?: stringProperty Value
string
model
The model of the device
model?: stringProperty Value
string
nicEntityIds
A list of Nic entity ids of the IoTDevice entity.
nicEntityIds?: string[]Property Value
string[]
operatingSystem
The operating system of the device
operatingSystem?: stringProperty Value
string
owners
A list of owners of the IoTDevice entity.
owners?: string[]Property Value
string[]
protocols
A list of protocols of the IoTDevice entity.
protocols?: string[]Property Value
string[]
purdueLayer
The Purdue Layer of the device
purdueLayer?: stringProperty Value
string
sensor
The sensor the device is monitored by
sensor?: stringProperty Value
string
serialNumber
The serial number of the device
serialNumber?: stringProperty Value
string
site
The site of the device
site?: stringProperty Value
string
source
The source of the device
source?: stringProperty Value
string
threatIntelligence
A list of TI contexts attached to the IoTDevice entity.
threatIntelligence?: ThreatIntelligence[]Property Value
vendor
The vendor of the device
vendor?: stringProperty Value
string
zone
The zone location of the device within a site
zone?: 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
