Remove-AzureDisk
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Remove-AzureDisk
Removes a disk from the Azure disk repository.
Syntax
Parameter Set: Default
Remove-AzureDisk [-DiskName] <String> [-DeleteVHD] [ <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-AzureDisk cmdlet removes a disk from the Azure disk repository in the current subscription. By default, this does not delete the associated physical VHD file from the blob storage location. To delete that VHD, specify the DeleteVHD parameter.
Parameters
-DeleteVHD
Removes the VHD file from blob storage.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DiskName<String>
Specifies the name of the data disk in the disk.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (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 example removes the "MyDataDisk" disk from the disk repository but does not remove the VHD file from Azure storage.
C:\PS>Remove-AzureDisk -DiskName "MyDataDisk"
Example 2
This example removes the "MyDataDisk" disk from the disk repository and also removes the VHD file from Azure storage.
C:\PS>Remove-AzureDisk -DiskName "MyDataDisk" –DeleteVHD