VirtualMachinesOperationsExtensions.ReimageAsync Method

Definition

Overloads

ReimageAsync(IVirtualMachinesOperations, String, String, Nullable<Boolean>, CancellationToken)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

ReimageAsync(IVirtualMachinesOperations, String, String, VirtualMachineReimageParameters, CancellationToken)

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.

ReimageAsync(IVirtualMachinesOperations, String, String, Nullable<Boolean>, CancellationToken)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

public static System.Threading.Tasks.Task ReimageAsync (this Microsoft.Azure.Management.Compute.IVirtualMachinesOperations operations, string resourceGroupName, string vmName, bool? tempDisk, System.Threading.CancellationToken cancellationToken = default);
static member ReimageAsync : Microsoft.Azure.Management.Compute.IVirtualMachinesOperations * string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function ReimageAsync (operations As IVirtualMachinesOperations, resourceGroupName As String, vmName As String, tempDisk As Nullable(Of Boolean), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
IVirtualMachinesOperations

The operations group for this extension method.

resourceGroupName
String

The name of the resource group.

vmName
String

The name of the virtual machine.

tempDisk
Nullable<Boolean>

Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to

ReimageAsync(IVirtualMachinesOperations, String, String, VirtualMachineReimageParameters, CancellationToken)

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.

public static System.Threading.Tasks.Task ReimageAsync (this Microsoft.Azure.Management.Compute.IVirtualMachinesOperations operations, string resourceGroupName, string vmName, Microsoft.Azure.Management.Compute.Models.VirtualMachineReimageParameters parameters = default, System.Threading.CancellationToken cancellationToken = default);
static member ReimageAsync : Microsoft.Azure.Management.Compute.IVirtualMachinesOperations * string * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineReimageParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function ReimageAsync (operations As IVirtualMachinesOperations, resourceGroupName As String, vmName As String, Optional parameters As VirtualMachineReimageParameters = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
IVirtualMachinesOperations

The operations group for this extension method.

resourceGroupName
String

The name of the resource group.

vmName
String

The name of the virtual machine.

parameters
VirtualMachineReimageParameters

Parameters supplied to the Reimage Virtual Machine operation.

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to