SecurityInsightsIotDeviceEntity Class

Definition

Represents an IoT device entity.

public class SecurityInsightsIotDeviceEntity : Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsEntity
public class SecurityInsightsIotDeviceEntity : Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsEntity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsIotDeviceEntity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsIotDeviceEntity>
type SecurityInsightsIotDeviceEntity = class
    inherit SecurityInsightsEntity
type SecurityInsightsIotDeviceEntity = class
    inherit SecurityInsightsEntity
    interface IJsonModel<SecurityInsightsIotDeviceEntity>
    interface IPersistableModel<SecurityInsightsIotDeviceEntity>
Public Class SecurityInsightsIotDeviceEntity
Inherits SecurityInsightsEntity
Public Class SecurityInsightsIotDeviceEntity
Inherits SecurityInsightsEntity
Implements IJsonModel(Of SecurityInsightsIotDeviceEntity), IPersistableModel(Of SecurityInsightsIotDeviceEntity)
Inheritance
SecurityInsightsIotDeviceEntity
Implements

Constructors

SecurityInsightsIotDeviceEntity()

Initializes a new instance of SecurityInsightsIotDeviceEntity.

Properties

AdditionalData

A bag of custom fields that should be part of the entity and will be presented to the user.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

DeviceId

The ID of the IoT Device in the IoT Hub.

DeviceName

The friendly name of the device.

DeviceSubType

The subType of the device ('PLC', 'HMI', 'EWS', etc.).

DeviceType

The type of the device.

EdgeId

The ID of the edge device.

FirmwareVersion

The firmware version of the device.

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.

HostEntityId

The Host entity id of this device.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Importance

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

IotHubEntityId

The AzureResource entity id of the IoT Hub.

IotSecurityAgentId

The ID of the security agent running on the device.

IPAddressEntityId

The IP entity if of this device.

IsAuthorized

Determines whether the device classified as authorized device.

IsProgramming

Determines whether the device classified as programming device.

IsScanner

Is the device classified as a scanner device.

MacAddress

The MAC address of the device.

Model

The model of the device.

Name

The name of the resource.

(Inherited from ResourceData)
NicEntityIds

A list of Nic entity ids of the IoTDevice entity.

OperatingSystem

The operating system of the device.

Owners

A list of owners of the IoTDevice entity.

Protocols

A list of protocols of the IoTDevice entity.

PurdueLayer

The Purdue Layer of the device.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
Sensor

The sensor the device is monitored by.

SerialNumber

The serial number of the device.

Site

The site of the device.

Source

The source of the device.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
ThreatIntelligence

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<SecurityInsightsEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from SecurityInsightsEntity)
IJsonModel<SecurityInsightsEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from SecurityInsightsEntity)
IJsonModel<SecurityInsightsIotDeviceEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SecurityInsightsIotDeviceEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SecurityInsightsEntity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from SecurityInsightsEntity)
IPersistableModel<SecurityInsightsEntity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from SecurityInsightsEntity)
IPersistableModel<SecurityInsightsEntity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from SecurityInsightsEntity)
IPersistableModel<SecurityInsightsIotDeviceEntity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SecurityInsightsIotDeviceEntity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SecurityInsightsIotDeviceEntity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to