POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture/?api-version=2023-09-01

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

Servers

Path parameters

Name Type Required Description
vmName String Yes

The name of the virtual machine.

subscriptionId String Yes

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName String Yes

The name of the resource group.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
destinationContainerName String Yes

The destination container name.

vhdPrefix String Yes

The captured virtual hard disk's name prefix.

overwriteVhds Boolean Yes

Specifies whether to overwrite the destination virtual hard disk, in case of conflict.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.