IoTAddon interface

IoT Addon.

Extends

Properties

hostPlatform

Host OS supported by the IoT addon. NOTE: This property will not be serialized. It can only be populated by the server.

hostPlatformType

Platform where the runtime is hosted. NOTE: This property will not be serialized. It can only be populated by the server.

ioTDeviceDetails

IoT device metadata to which appliance needs to be connected.

ioTEdgeDeviceDetails

IoT edge device to which the IoT Addon needs to be configured.

kind

Polymorphic discriminator, which specifies the different types this object can be

provisioningState

Addon Provisioning State NOTE: This property will not be serialized. It can only be populated by the server.

version

Version of IoT running on the appliance. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

name

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

systemData

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

type

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

Property Details

hostPlatform

Host OS supported by the IoT addon. NOTE: This property will not be serialized. It can only be populated by the server.

hostPlatform?: string

Property Value

string

hostPlatformType

Platform where the runtime is hosted. NOTE: This property will not be serialized. It can only be populated by the server.

hostPlatformType?: string

Property Value

string

ioTDeviceDetails

IoT device metadata to which appliance needs to be connected.

ioTDeviceDetails: IoTDeviceInfo

Property Value

ioTEdgeDeviceDetails

IoT edge device to which the IoT Addon needs to be configured.

ioTEdgeDeviceDetails: IoTDeviceInfo

Property Value

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "IotEdge"

Property Value

"IotEdge"

provisioningState

Addon Provisioning State NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

version

Version of IoT running on the appliance. NOTE: This property will not be serialized. It can only be populated by the server.

version?: string

Property Value

string

Inherited Property Details

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Addon.id

name

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

name?: string

Property Value

string

Inherited From Addon.name

systemData

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

systemData?: SystemData

Property Value

Inherited From Addon.systemData

type

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

type?: string

Property Value

string

Inherited From Addon.type