Get-AzDataBoxEdgeRole

Module:

Az.DataBoxEdge

Fetches the available roles for a device.

Syntax

Get-AzDataBoxEdgeRole
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeRole
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeRole
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeRole
   [[-Name] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   -DeviceObject <PSDataBoxEdgeDevice>
   [<CommonParameters>]

Description

The Get-AzDataBoxEdgeRole cmdlet fetches the available IoT roles for a Data Box Edge device. You can mention the Name parameter to get the details of a specific IoT role.

Examples

Example 1

Get-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName

Name    IoTHostHub             Platform Status  IotEdgeDeviceId   IotDeviceId  ResourceGroupName
----    ----------             -------- ------  ---------------   -----------  -----------------
iotrole ehub.azure-devices.net Linux    Enabled iotEdgeDeviceUd   iotDevice    resourceGroupName

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceName

Device Name

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceObject

Please provide corresponding device object

Type:	PSDataBoxEdgeDevice
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Resource Name

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

Azure ResourceId

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSDataBoxEdgeDevice

Outputs

PSDataBoxEdgeRole