IoTRole interface

Compute role.

Extends

Properties

hostPlatform

Host OS supported by the IoT role.

ioTDeviceDetails

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

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.

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 role.

hostPlatform?: string

Property Value

string

ioTDeviceDetails

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

ioTDeviceDetails?: IoTDeviceInfo

Property Value

ioTEdgeDeviceDetails

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

ioTEdgeDeviceDetails?: IoTDeviceInfo

Property Value

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

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

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