Package com.azure.resourcemanager.securityinsights.models

Class IoTDeviceEntity

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.securityinsights.fluent.models.EntityInner
com.azure.resourcemanager.securityinsights.models.IoTDeviceEntity
public final class IoTDeviceEntity extends EntityInner
Represents an IoT device entity.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IoTDeviceEntity()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    additionalData()
    Get the additionalData property: A bag of custom fields that should be part of the entity and will be presented to the user.
    String
    deviceId()
    Get the deviceId property: The ID of the IoT Device in the IoT Hub.
    String
    deviceName()
    Get the deviceName property: The friendly name of the device.
    String
    deviceSubType()
    Get the deviceSubType property: The subType of the device ('PLC', 'HMI', 'EWS', etc.).
    String
    deviceType()
    Get the deviceType property: The type of the device.
    String
    edgeId()
    Get the edgeId property: The ID of the edge device.
    String
    firmwareVersion()
    Get the firmwareVersion property: The firmware version of the device.
    String
    friendlyName()
    Get the friendlyName property: The graph item display name which is a short humanly readable description of the graph item instance.
    String
    hostEntityId()
    Get the hostEntityId property: The Host entity id of this device.
    DeviceImportance
    importance()
    Get the importance property: Device importance, determines if the device classified as 'crown jewel'.
    String
    iotHubEntityId()
    Get the iotHubEntityId property: The AzureResource entity id of the IoT Hub.
    UUID
    iotSecurityAgentId()
    Get the iotSecurityAgentId property: The ID of the security agent running on the device.
    String
    ipAddressEntityId()
    Get the ipAddressEntityId property: The IP entity if of this device.
    Boolean
    isAuthorized()
    Get the isAuthorized property: Determines whether the device classified as authorized device.
    Boolean
    isProgramming()
    Get the isProgramming property: Determines whether the device classified as programming device.
    Boolean
    isScanner()
    Get the isScanner property: Is the device classified as a scanner device.
    String
    macAddress()
    Get the macAddress property: The MAC address of the device.
    String
    model()
    Get the model property: The model of the device.
    List<String>
    nicEntityIds()
    Get the nicEntityIds property: A list of Nic entity ids of the IoTDevice entity.
    String
    operatingSystem()
    Get the operatingSystem property: The operating system of the device.
    List<String>
    owners()
    Get the owners property: A list of owners of the IoTDevice entity.
    List<String>
    protocols()
    Get the protocols property: A list of protocols of the IoTDevice entity.
    String
    purdueLayer()
    Get the purdueLayer property: The Purdue Layer of the device.
    String
    sensor()
    Get the sensor property: The sensor the device is monitored by.
    String
    serialNumber()
    Get the serialNumber property: The serial number of the device.
    String
    site()
    Get the site property: The site of the device.
    String
    source()
    Get the source property: The source of the device.
    List<ThreatIntelligence>
    threatIntelligence()
    Get the threatIntelligence property: A list of TI contexts attached to the IoTDevice entity.
    void
    validate()
    Validates the instance.
    String
    vendor()
    Get the vendor property: The vendor of the device.
    IoTDeviceEntity
    withImportance(DeviceImportance importance)
    Set the importance property: Device importance, determines if the device classified as 'crown jewel'.
    String
    zone()
    Get the zone property: The zone location of the device within a site.

    Methods inherited from class com.azure.resourcemanager.securityinsights.fluent.models.EntityInner

    systemData

    Methods inherited from class com.azure.core.management.ProxyResource

    id, name, type

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • IoTDeviceEntity

      public IoTDeviceEntity()

  • Method Details

    • deviceId

      public String deviceId()
      Get the deviceId property: The ID of the IoT Device in the IoT Hub.
      Returns:
      the deviceId value.

    • deviceName

      public String deviceName()
      Get the deviceName property: The friendly name of the device.
      Returns:
      the deviceName value.

    • source

      public String source()
      Get the source property: The source of the device.
      Returns:
      the source value.

    • iotSecurityAgentId

      public UUID iotSecurityAgentId()
      Get the iotSecurityAgentId property: The ID of the security agent running on the device.
      Returns:
      the iotSecurityAgentId value.

    • deviceType

      public String deviceType()
      Get the deviceType property: The type of the device.
      Returns:
      the deviceType value.

    • vendor

      public String vendor()
      Get the vendor property: The vendor of the device.
      Returns:
      the vendor value.

    • edgeId

      public String edgeId()
      Get the edgeId property: The ID of the edge device.
      Returns:
      the edgeId value.

    • macAddress

      public String macAddress()
      Get the macAddress property: The MAC address of the device.
      Returns:
      the macAddress value.

    • model

      public String model()
      Get the model property: The model of the device.
      Returns:
      the model value.

    • serialNumber

      public String serialNumber()
      Get the serialNumber property: The serial number of the device.
      Returns:
      the serialNumber value.

    • firmwareVersion

      public String firmwareVersion()
      Get the firmwareVersion property: The firmware version of the device.
      Returns:
      the firmwareVersion value.

    • operatingSystem

      public String operatingSystem()
      Get the operatingSystem property: The operating system of the device.
      Returns:
      the operatingSystem value.

    • iotHubEntityId

      public String iotHubEntityId()
      Get the iotHubEntityId property: The AzureResource entity id of the IoT Hub.
      Returns:
      the iotHubEntityId value.

    • hostEntityId

      public String hostEntityId()
      Get the hostEntityId property: The Host entity id of this device.
      Returns:
      the hostEntityId value.

    • ipAddressEntityId

      public String ipAddressEntityId()
      Get the ipAddressEntityId property: The IP entity if of this device.
      Returns:
      the ipAddressEntityId value.

    • threatIntelligence

      public List<ThreatIntelligence> threatIntelligence()
      Get the threatIntelligence property: A list of TI contexts attached to the IoTDevice entity.
      Returns:
      the threatIntelligence value.

    • protocols

      public List<String> protocols()
      Get the protocols property: A list of protocols of the IoTDevice entity.
      Returns:
      the protocols value.

    • owners

      public List<String> owners()
      Get the owners property: A list of owners of the IoTDevice entity.
      Returns:
      the owners value.

    • nicEntityIds

      public List<String> nicEntityIds()
      Get the nicEntityIds property: A list of Nic entity ids of the IoTDevice entity.
      Returns:
      the nicEntityIds value.

    • site

      public String site()
      Get the site property: The site of the device.
      Returns:
      the site value.

    • zone

      public String zone()
      Get the zone property: The zone location of the device within a site.
      Returns:
      the zone value.

    • sensor

      public String sensor()
      Get the sensor property: The sensor the device is monitored by.
      Returns:
      the sensor value.

    • deviceSubType

      public String deviceSubType()
      Get the deviceSubType property: The subType of the device ('PLC', 'HMI', 'EWS', etc.).
      Returns:
      the deviceSubType value.

    • importance

      public DeviceImportance importance()
      Get the importance property: Device importance, determines if the device classified as 'crown jewel'.
      Returns:
      the importance value.

    • withImportance

      public IoTDeviceEntity withImportance(DeviceImportance importance)
      Set the importance property: Device importance, determines if the device classified as 'crown jewel'.
      Parameters:
      importance - the importance value to set.
      Returns:
      the IoTDeviceEntity object itself.

    • purdueLayer

      public String purdueLayer()
      Get the purdueLayer property: The Purdue Layer of the device.
      Returns:
      the purdueLayer value.

    • isAuthorized

      public Boolean isAuthorized()
      Get the isAuthorized property: Determines whether the device classified as authorized device.
      Returns:
      the isAuthorized value.

    • isProgramming

      public Boolean isProgramming()
      Get the isProgramming property: Determines whether the device classified as programming device.
      Returns:
      the isProgramming value.

    • isScanner

      public Boolean isScanner()
      Get the isScanner property: Is the device classified as a scanner device.
      Returns:
      the isScanner value.

    • additionalData

      public Map<String,Object> additionalData()
      Get the additionalData property: A bag of custom fields that should be part of the entity and will be presented to the user.
      Returns:
      the additionalData value.

    • friendlyName

      public String friendlyName()
      Get the friendlyName property: 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.
      Returns:
      the friendlyName value.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class EntityInner
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.