VirtualMachineResource.CaptureAsync Method

Definition

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture
  • Operation Id: VirtualMachines_Capture
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Compute.Models.VirtualMachineCaptureResult>> CaptureAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineCaptureContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CaptureAsync : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineCaptureContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Compute.Models.VirtualMachineCaptureResult>>
override this.CaptureAsync : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineCaptureContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Compute.Models.VirtualMachineCaptureResult>>
Public Overridable Function CaptureAsync (waitUntil As WaitUntil, content As VirtualMachineCaptureContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of VirtualMachineCaptureResult))

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
VirtualMachineCaptureContent

Parameters supplied to the Capture Virtual Machine operation.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to