Get-AzDataBoxEdgeUser

Reference

Module:: Az.DataBoxEdge

Gets the configured users for a device.

Syntax

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

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

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

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

Description

The Get-AzDataBoxEdgeUser cmdlet lists the users configured for a Data Box Edge device. You can mention the Name in parameters to get details about a specific user.

Examples

Example 1

Get-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName

User name  Type  ResourceGroupName DeviceName
---------  ----  ----------------- ----------
deviceName Share resourceGroupName deviceName

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

Username

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

PSDataBoxEdgeUser

Share via