Remove-AzVMDataDisk
Removes a data disk from a virtual machine.
Syntax
Default (Default)
Remove-AzVMDataDisk
[-VM] <PSVirtualMachine>
[[-DataDiskNames] <String[]>]
[-ForceDetach]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzVMDataDisk cmdlet removes a data disk from a virtual machine.
Examples
Example 1: Remove a data disk from a virtual machine
$VirtualMachine = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"
Remove-AzVMDataDisk -VM $VirtualMachine -Name "Disk3"
Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine
The first command gets the virtual machine named VirtualMachine07 by using the Get-AzVM cmdlet.
The command stores the virtual machine in the $VirtualMachine variable.
The second command removes the data disk named Disk3 from the virtual machine stored in $VirtualMachine.
The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataDiskNames
Specifies the names of one or more data disks that this cmdlet removes.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
(All)
Position: 1 Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ForceDetach
Sets detachOption property to ForceDetach for the provided disk(s). Only applicable for managed data disks.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VM
Specifies the local virtual machine object from which to remove a data disk.
To obtain a virtual machine object, use the Get-AzVM cmdlet.
Parameter properties
Type: PSVirtualMachine
Default value: None Supports wildcards: False DontShow: False Aliases: VMProfile
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs