Share via

IoTDeviceEntityProperties interface

Package:
@azure/arm-securityinsight

IoTDevice entity property bag.

Extends
EntityCommonProperties

Properties

deviceId

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.
deviceName

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

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

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

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

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

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

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

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

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.
ipAddressEntityId

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

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

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

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

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

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

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.
operatingSystem

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

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

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

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

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

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

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

The source of the device NOTE: This property will not be serialized. It can only be populated by the server.
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.
vendor

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

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

Inherited 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.
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.

Property Details

deviceId

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.

deviceId?: string

Property Value

string

deviceName

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

deviceName?: string

Property Value

string

deviceSubType

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

deviceSubType?: string

Property Value

string

deviceType

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

deviceType?: string

Property Value

string

edgeId

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

edgeId?: string

Property Value

string

firmwareVersion

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

firmwareVersion?: string

Property Value

string

hostEntityId

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

hostEntityId?: string

Property Value

string

importance

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

importance?: string

Property Value

string

iotHubEntityId

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

iotHubEntityId?: string

Property Value

string

iotSecurityAgentId

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.

iotSecurityAgentId?: string

Property Value

string

ipAddressEntityId

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

ipAddressEntityId?: string

Property Value

string

isAuthorized

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

isAuthorized?: boolean

Property Value

boolean

isProgramming

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

isProgramming?: boolean

Property Value

boolean

isScanner

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

isScanner?: boolean

Property Value

boolean

macAddress

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

macAddress?: string

Property Value

string

model

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

model?: string

Property Value

string

nicEntityIds

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.

nicEntityIds?: string[]

Property Value

string[]

operatingSystem

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

operatingSystem?: string

Property Value

string

owners

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

owners?: string[]

Property Value

string[]

protocols

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

protocols?: string[]

Property Value

string[]

purdueLayer

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

purdueLayer?: string

Property Value

string

sensor

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

sensor?: string

Property Value

string

serialNumber

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

serialNumber?: string

Property Value

string

site

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

site?: string

Property Value

string

source

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

source?: string

Property Value

string

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.

threatIntelligence?: ThreatIntelligence[]

Property Value

ThreatIntelligence[]

vendor

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

vendor?: string

Property Value

string

zone

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

zone?: string

Property Value

string

Inherited 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>}

Inherited From EntityCommonProperties.additionalData

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

Inherited From EntityCommonProperties.friendlyName