IVirtualMachines.CaptureAsync Method

Definition

Captures the virtual machine by copying virtual hard disks of the VM asynchronously.

public System.Threading.Tasks.Task<string> CaptureAsync (string groupName, string name, string containerName, string vhdPrefix, bool overwriteVhd, System.Threading.CancellationToken cancellationToken = default);
abstract member CaptureAsync : string * string * string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Function CaptureAsync (groupName As String, name As String, containerName As String, vhdPrefix As String, overwriteVhd As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

groupName
System.String

The resource group name.

name
System.String

The virtual machine name.

containerName
System.String

Destination container name to store the captured VHD.

vhdPrefix
System.String

The prefix for the VHD holding captured image.

overwriteVhd
System.Boolean

Whether to overwrites destination VHD if it exists.

cancellationToken
System.Threading.CancellationToken

Returns

System.Threading.Tasks.Task<System.String>

Applies to