Remove-AzureDataDisk
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Remove-AzureDataDisk
Removes a data disk from a virtual machine object.
Syntax
Parameter Set: Default
Remove-AzureDataDisk [-LUN] <Int32> [[-DeleteVHD]] -VM <IPersistentVM> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The Remove-AzureDataDisk cmdlet detaches a data disk from a virtual machine. The data disk blob is not removed from the storage account.
Parameters
-DeleteVHD
Indicates that this cmdlet removes the data disk and the underlying disk blob.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LUN<Int32>
Specifies the slot where the data disk to be detached is currently mounted.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<IPersistentVM>
The virtual machine where the data disk is mounted.
Aliases |
InputObject |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This command gets the “Database” virtual machine running on the "myservice" cloud service, passes the object on the pipeline to Remove-AzureDataDisk to detach the data disk at LUN 2 of the virtual machine, and then pipes that updated object to Update-AzureVM to complete the removal.
C:\PS>Get-AzureVM "myservice" –name “Database” ` | Remove-AzureDataDisk -LUN 2 ` | Update-AzureVM