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

azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.Role

IoTRole

Constructor

IoTRole(*, host_platform: Optional[Union[str, azure.mgmt.databoxedge.v2020_05_01_preview.models._data_box_edge_management_client_enums.PlatformType]] = None, io_t_device_details: Optional[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.IoTDeviceInfo] = None, io_t_edge_device_details: Optional[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.IoTDeviceInfo] = None, share_mappings: Optional[List[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.MountPointMap]] = None, io_t_edge_agent_info: Optional[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.IoTEdgeAgentInfo] = None, role_status: Optional[Union[str, azure.mgmt.databoxedge.v2020_05_01_preview.models._data_box_edge_management_client_enums.RoleStatus]] = None, **kwargs)

Parameters

kind

str or RoleTypes

Required

Required. Role type.Constant filled by server. Possible values include: "IOT", "ASA", "Functions", "Cognitive".

host_platform

str or PlatformType

Required

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

io_t_device_details

IoTDeviceInfo

Required

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

io_t_edge_device_details

IoTDeviceInfo

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

io_t_edge_agent_info

IoTEdgeAgentInfo

Required

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

role_status

str or RoleStatus

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.

host_platform_type

str or HostPlatformType

Platform where the Iot runtime is hosted. Possible values include: "KubernetesCluster", "LinuxVM".