Remove-AzDataBoxEdgeDevice
Removes a Data Box Edge device.
Syntax
Remove-AzDataBoxEdgeDevice
[-ResourceGroupName] <String>
[-Name] <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzDataBoxEdgeDevice
-ResourceId <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzDataBoxEdgeDevice
-InputObject <PSDataBoxEdgeDevice>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-AzDataBoxEdgeDevice cmdlet removes the configuration for a Data Box Edge device. Note that the device can only be deleted after you have placed the order and before the device is prepared by Microsoft for shipment.
Refer the documentation on Deleting the resource before using this cmdlet
Examples
Example 1
Remove-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceNameParameters
-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 |
-InputObject
Input Object
| Type: | PSDataBoxEdgeDevice |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Resource 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: | True |
| 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 |