Share via

VirtualMachineResource.ReimageAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.5.0
Package:
Azure.ResourceManager.Compute v1.5.0-beta.1
Source:
VirtualMachineResource.cs
Source:
VirtualMachineResource.cs

Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage
  • Operation Id: VirtualMachines_Reimage
  • Default Api Version: 2024-03-01
  • Resource: VirtualMachineResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> ReimageAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineReimageContent content = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReimageAsync : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineReimageContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.ReimageAsync : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineReimageContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function ReimageAsync (waitUntil As WaitUntil, Optional content As VirtualMachineReimageContent = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.

content
VirtualMachineReimageContent

Parameters supplied to the Reimage Virtual Machine operation.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Applies to