Share via

IoTRole interface

  • Reference
Package:
@azure/arm-databoxedge

Compute role.

Extends
Role

Properties

computeResource

Resource allocation
hostPlatform

Host OS supported by the IoT role.
hostPlatformType

Platform where the Iot runtime is hosted. NOTE: This property will not be serialized. It can only be populated by the server.
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.
kind

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

Role status.
shareMappings

Mount points of shares in role(s).

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

Role configured on ASE resource 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

computeResource

Resource allocation

computeResource?: ComputeResource

Property Value

ComputeResource

hostPlatform

Host OS supported by the IoT role.

hostPlatform?: string

Property Value

string

hostPlatformType

Platform where the Iot 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 data box edge device needs to be connected.

ioTDeviceDetails?: IoTDeviceInfo

Property Value

IoTDeviceInfo

ioTEdgeAgentInfo

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

ioTEdgeAgentInfo?: IoTEdgeAgentInfo

Property Value

IoTEdgeAgentInfo

ioTEdgeDeviceDetails

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

ioTEdgeDeviceDetails?: IoTDeviceInfo

Property Value

IoTDeviceInfo

kind

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

kind: "IOT"

Property Value

"IOT"

roleStatus

Role status.

roleStatus?: string

Property Value

string

shareMappings

Mount points of shares in role(s).

shareMappings?: MountPointMap[]

Property Value

MountPointMap[]

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 Role.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 Role.name

systemData

Role configured on ASE resource NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Role.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 Role.type