< Back

Remove-AzureDataDisk

Wed Jan 30, 2019 5:50 pm

NAME Remove-AzureDataDisk



SYNOPSIS

Removes a data disk from an Azure virtual machine.





SYNTAX

Remove-AzureDataDisk [-LUN] <Int32> [[-DeleteVHD]] -VM <IPersistentVM> [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>]

[-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Remove-AzureDataDisk cmdlet removes a data disk from an Azure virtual machine. By default, this cmdlet does not remove the data disk blob from the

storage account.





PARAMETERS

-LUN <Int32>

Specifies the logical unit number (LUN) for the data drive in the virtual machine. Valid values are: 0 through 15.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DeleteVHD [<SwitchParameter>]

Indicates that this cmdlet removes the data disk and the virtual hard disk (VHD) from blob storage.



Required? false

Position? 1

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-VM <IPersistentVM>

Specifies the virtual machine object that is attached to the data disk. To obtain a virtual machine object, use the Get-AzureVM cmdlet.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Remove a data disk --------------------------



PS C:\\>Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine07" | Remove-AzureDataDisk -LUN 0



This command gets the virtual machine named VirtualMachine07 in the service named ContosoService by using the Get-AzureVM cmdlet. The command passes the

virtual machine to the current cmdlet by using the pipeline operator. The current cmdlet removes the data disk that has the LUN 0.

-------------------------- Example 2: Remove a data disk and the virtual hard disk file --------------------------



PS C:\\>Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine07" | Remove-AzureDataDisk -LUN 0 -DeleteVHD | Update-AzureVM



This command gets the virtual machine named VirtualMachine07 in the service named ContosoService. The command passes the virtual machine to the current

cmdlet. The current cmdlet removes the data disk that has the LUN 0. The command includes the DeleteVHD parameter. Therefore, it also deletes the

underlying virtual hard disk. The command updates the virtual machine to reflect your changes by using the Update-AzureVM cmdlet.



RELATED LINKS

Add-AzureDataDisk

Get-AzureDataDisk

Get-AzureVM

Set-AzureDataDisk

Update-AzureVM