VirtualMachineResource.Delete Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The operation to delete a virtual machine.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
- Operation Id: VirtualMachines_Delete
- Default Api Version: 2024-11-01
- Resource: VirtualMachineResource
public virtual Azure.ResourceManager.ArmOperation Delete(Azure.WaitUntil waitUntil, bool? forceDeletion = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Delete : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.Delete : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function Delete (waitUntil As WaitUntil, Optional forceDeletion As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation
Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
Optional parameter to force delete virtual machines. NOTE: As of api-version 2024-11-01, we are rolling out a feature where if the forceDeletion parameter is unspecified OR not explicitly set to false, AND all of the VM's attached disks including the OS disk are marked with the delete option, then the VM will be force deleted. For more details on how to configure delete options for a VM's resources, see Delete a VM and attached resources. To avoid defaulting to force delete, ensure that the forceDeletion parameter is explicitly set to false. This feature is expected to rollout by end of March 2025.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
Azure SDK for .NET