Invoke-AzDataBoxEdgeDevice

Reference

Module:: Az.DataBoxEdge

Invokes specific actions on the device.

Syntax

Invoke-AzDataBoxEdgeDevice
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-ScanForUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      -ResourceId <String>
      [-FetchUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      -ResourceId <String>
      [-InstallUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      -ResourceId <String>
      [-ScanForUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-InstallUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-FetchUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      -DeviceObject <PSDataBoxEdgeDevice>
      [-FetchUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      -DeviceObject <PSDataBoxEdgeDevice>
      [-ScanForUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataBoxEdgeDevice
      -DeviceObject <PSDataBoxEdgeDevice>
      [-InstallUpdate]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Invoke-AzDataBoxEdgeDevice cmdlet invokes actions to scan, download and install the updates on the Data Box Edge device. An automatic scan runs on the device daily, you can trigger the scan explicitly by running this cmdlet.

Examples

Example 1

Invoke-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -ScanForUpdate

Example 2

Invoke-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -FetchUpdate

Example 3

Invoke-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -InstallUpdate

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
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

-DeviceObject

Please provide corresponding device object

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

-FetchUpdate

Downloads the updates on a data box edge/gateway device

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

-InstallUpdate

Installs the updates on the data box edge/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

-PassThru

returns true if successful

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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

-ScanForUpdate

Scans for updates on a data box edge/gateway device.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

None

Outputs

Boolean

Share via