IoTRole Class

Compute role.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

Role

IoTRole

Constructor

IoTRole(*, host_platform, io_tdevice_details, io_tedge_device_details, role_status, share_mappings=None, **kwargs)

Parameters

kind

str

Required

Required. Constant filled by server.

host_platform

str or PlatformType

Required

Required. Host OS supported by the IoT role. Possible values include: 'Windows', 'Linux'

io_tdevice_details

IoTDeviceInfo

Required

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

io_tedge_device_details

IoTDeviceInfo

Required

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

share_mappings

list[MountPointMap]

Required

Mount points of shares in role(s).

role_status

str or RoleStatus

Required

Required. Role status. Possible values include: 'Enabled', 'Disabled'

Variables

id

str

The path ID that uniquely identifies the object.

name

str

The object name.

type

str

The hierarchical type of the object.