Get-AzDataBoxEdgeJob

Reference

Module:: Az.DataBoxEdge

Gets the jobs scheduled on a device.

Syntax

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

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

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

Description

The Get-AzDataBoxEdgeJob cmdlet gets the active jobs on a Data Box Edge device. You can mention the Name parameter to get details of a specific job.

Examples

Example 1

Get-AzDataBoxEdgeJob -ResourceGroupName resourceGroupName -DeviceName deviceName -Name 1f2d8f1b-9104-49c3-b780-76db9abe7bd1

Name                                   Device-Name    status
------------------                     -------------  -------
1f2d8f1b-9104-49c3-b780-76db9abe7bd1   deviceName    Scheduled

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

Name of the device

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

Name of the Job, Generally a GUID

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

PSDataBoxEdgeJob

Share via