Edit

Share via

Remove-AzureDisk

  • Reference
Module:
Azure

Removes a disk from the Azure disk repository.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Remove-AzureDisk
      [-DiskName] <String>
      [-DeleteVHD]
      [-Profile <AzureSMProfile>]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]

Description

The Remove-AzureDisk cmdlet removes a disk from the Azure disk repository in the current subscription. By default, this cmdlet does not delete the virtual hard disk (VHD) file from blob storage. To delete the VHD, specify the DeleteVHD parameter.

Examples

Example 1: Remove a disk

PS C:\> Remove-AzureDisk -DiskName "ContosoDataDisk"

This command removes the disk named ContosoDataDisk disk from the disk repository. The command does not delete the VHD.

Example 2: Remove and delete a disk

PS C:\> Remove-AzureDisk -DiskName "ContosoDataDisk" -DeleteVHD

This command removes the disk named ContosoDataDisk disk from the disk repository. This command specifies the DeleteVHD parameter. Therefore, the command deletes the VHD from Azure Storage.

Parameters

-DeleteVHD

Indicates that this cmdlet removes the VHD from blob storage.

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

-DiskName

Specifies the name of the data disk in the disk repository that this cmdlet removes.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

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

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