Get-AzDataBoxEdgeDevice

Reference

Module:: Az.DataBoxEdge

Gets the information on available Data Box Edge devices.

Syntax

Get-AzDataBoxEdgeDevice
   [[-ResourceGroupName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Get-AzDataBoxEdgeDevice
   -ResourceId <String>
   [-ExtendedInfo]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeDevice
   -ResourceId <String>
   [-NetworkSetting]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeDevice
   -ResourceId <String>
   [-UpdateSummary]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeDevice
   -ResourceId <String>
   [-Alert]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Get-AzDataBoxEdgeDevice
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-UpdateSummary]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeDevice
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-NetworkSetting]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeDevice
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-ExtendedInfo]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDataBoxEdgeDevice
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-Alert]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDataBoxEdgeDevice cmdlet gets the information about the available Data Box Edge Devices. You can specify the Name of the device along with the Resource Group Name to get the information on a specific device.

Examples

Example 1

Get-AzDataBoxEdgeDevice

Name               ResourceGroupName  Model   Location
----               -----------------  -----   --------
deviceNameOne      resourceGroupName1 Edge    eastus
deviceNameTwo      resourceGroupName2 Edge    westus
deviceNameThree    resourceGroupName3 Gateway eastus

Example 2

Get-AzDataBoxEdgeDevice -ResourceId /subscriptions/subscriptionId/resourcegroups/resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceName

Name            ResourceGroupName    Model   Location
----            -----------------    -----   --------
deviceName      resourceGroupName    Edge    eastus

Example 3

Get-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName

Name            ResourceGroupName    Model   Location
----            -----------------    -----   --------
deviceName      resourceGroupName    Edge    eastus

Parameters

-Alert

Fetch the alerts on the data box edge/gateway device

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

-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

-ExtendedInfo

Gets additional information for the specified Data Box Edge/Data Box Gateway device

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

-Name

Device Name

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

-NetworkSetting

Gets the network settings of the specified Data Box Edge/Data Box Gateway device

Type:	SwitchParameter
Position:	Named
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

-UpdateSummary

Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.