Perform VM Restore
You can can restore an entire Azure VM to a restore point with the specified ID.
Request
To restore an Azure VM to a specific restore point, send the HTTP POST request to the /restorePoints/{restorePointId}/restoreVm endpoint. {restorePointId} is a system ID assigned to the restore point of an Azure VM in the Veeam Backup for Microsoft Azure REST API.
HTTP Request
POST https://<hostname>/api/v2/restorePoints/{restorePointId}/restoreVm |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Request Body
To perform a vm restore operation, use the VirtualMachineRestoreOptionsV2 schema to send parameters in the request body.
Set the parameter values in the following format:
{ "reason": "string", "toAlternative": { "name": "string", "subscription": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "environment": "Global", "tenantId": "string", "tenantName": "string", "name": "string", "status": "Active", "_links": { "additionalProp1": { "href": "string" }, "additionalProp2": { "href": "string" }, "additionalProp3": { "href": "string" } } }, "resourceGroup": { "id": "string", "resourceId": "string", "name": "string", "azureEnvironment": "Global", "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "regionId": "string", "_links": { "additionalProp1": { "href": "string" }, "additionalProp2": { "href": "string" }, "additionalProp3": { "href": "string" } } }, "region": { "id": "string", "name": "string" }, "vmSizeName": "string", "virtualNetwork": { "id": "string", "name": "string", "regionName": "string", "addressSpaces": [ "string" ] }, "subnet": { "networkSecurityGroup": { "id": "string", "name": "string", "regionId": "string", "resourceGroupName": "string", "subscriptionId": "string" }, "name": "string", "addressSpace": "string" }, "networkSecurityGroup": { "id": "string", "name": "string", "regionId": "string", "resourceGroupName": "string", "subscriptionId": "string" }, "availabilitySet": { "id": "string", "name": "string", "regionName": "string" }, "availabilityZone": { "subscriptionId": "string", "regionId": "string", "name": "string" }, "diskType": "Managed", "osDisk": { "diskId": "string", "name": "string", "resourceGroup": { "id": "string", "resourceId": "string", "name": "string", "azureEnvironment": "Global", "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "regionId": "string", "_links": { "additionalProp1": { "href": "string" }, "additionalProp2": { "href": "string" }, "additionalProp3": { "href": "string" } } }, "storageAccount": { "id": "string", "resourceId": "string", "name": "string", "skuName": "string", "performance": "Standard", "redundancy": "Unknown", "accessTier": "string", "regionId": "string", "regionName": "string", "removedFromAzure": true, "supportsTiering": true } }, "dataDisks": [ { "diskId": "string", "name": "string", "resourceGroup": { "id": "string", "resourceId": "string", "name": "string", "azureEnvironment": "Global", "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "regionId": "string", "_links": { "additionalProp1": { "href": "string" }, "additionalProp2": { "href": "string" }, "additionalProp3": { "href": "string" } } }, "storageAccount": { "id": "string", "resourceId": "string", "name": "string", "skuName": "string", "performance": "Standard", "redundancy": "Unknown", "accessTier": "string", "regionId": "string", "regionName": "string", "removedFromAzure": true, "supportsTiering": true } } ] }, "startVmAfterRestore": true } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns the session ID of the restore operation. For the session log details, see VirtualMachineRestoreOptionsV2.
Example
The following request starts the restore operation of the Azure VM to the restore point with the ID 047a1f81-b7fe-457b-90ce-531e465e2d7b.
|