IoTRole interface

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.
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	Role type.
roleStatus	Role status.
shareMappings	Mount points of shares in role(s).

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

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

Role type.

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

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From Role.id

name

The name of the resource

name?: string

Property Value

string

Inherited From Role.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From Role.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From Role.type