IoTRoleProperties interface

IoT role properties.

Properties

computeResource

Resource allocation

hostPlatform

Host OS supported by the IoT role.

hostPlatformType

Platform where the Iot runtime is hosted.

ioTDeviceDetails

IoT device metadata to which data box edge device needs to be connected.

ioTEdgeAgentInfo

Iot edge agent details to download the agent and bootstrap iot runtime.

ioTEdgeDeviceDetails

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

roleStatus

Role status.

shareMappings

Mount points of shares in role(s).

Property Details

computeResource

Resource allocation

computeResource?: ComputeResource

Property Value

hostPlatform

Host OS supported by the IoT role.

hostPlatform: string

Property Value

string

hostPlatformType

Platform where the Iot runtime is hosted.

hostPlatformType?: string

Property Value

string

ioTDeviceDetails

IoT device metadata to which data box edge device needs to be connected.

ioTDeviceDetails: IoTDeviceInfo

Property Value

ioTEdgeAgentInfo

Iot edge agent details to download the agent and bootstrap iot runtime.

ioTEdgeAgentInfo?: IoTEdgeAgentInfo

Property Value

ioTEdgeDeviceDetails

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

ioTEdgeDeviceDetails: IoTDeviceInfo

Property Value

roleStatus

Role status.

roleStatus: string

Property Value

string

shareMappings

Mount points of shares in role(s).

shareMappings?: MountPointMap[]

Property Value