VirtualMachineResource.Capture Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Compute.Models.VirtualMachineCaptureResult> Capture (Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineCaptureContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member Capture : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineCaptureContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Compute.Models.VirtualMachineCaptureResult>
override this.Capture : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineCaptureContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Compute.Models.VirtualMachineCaptureResult>
Public Overridable Function Capture (waitUntil As WaitUntil, content As VirtualMachineCaptureContent, Optional cancellationToken As CancellationToken = Nothing) As 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.