IVirtualMachines.Capture(String, String, String, String, Boolean) Method

Definition

Captures the virtual machine by copying virtual hard disks of the VM and returns template as a JSON string that can be used to create similar VMs.

public string Capture (string groupName, string name, string containerName, string vhdPrefix, bool overwriteVhd);
abstract member Capture : string * string * string * string * bool -> string
Public Function Capture (groupName As String, name As String, containerName As String, vhdPrefix As String, overwriteVhd As Boolean) As 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.

Returns

System.String

Applies to