Restore as Virtual Machine API

sessionId -

String (GUID)obtained via a prior call to Hyper-V Create Session API.

hostId

Integer, id of the host, either obtained when it was registered the first time, or via the Get registered hosts API call

recoveryType

Either TestRecovery or ProductionRecovery. If TestRecovery, virtualSwitchId must not be provided. It is only applicable for production recovery.

diskLocation

path

Local folder or network share. For network shares, user and password can be provided by additional parameter.

diskLocation

credentials

Optional, network share only.

userName - optional parameter to use for shares requiring auth.

password - optional parameter to use for shares requiring auth.

diskFormat

String, allowed values are Vhd or Vhdx. This parameter is validated against capabilities restore time but can be pre-validated using the validation API s (see other APIs in this section).

firmwareType

String, allowed values are Bios or Uefi. This parameter is validated against capabilities at restore time but can be pre-validated using the validation APIs (see other APIs in this section).

hostProperties

name - string, name of the virtual machine on which the restored volumes is running (this is typically the host name that was backed up, since that very same system is being restored, however, any name can be used). Can be obtained the Get registered hosts APIs, hostName parameter of the host that is being restored.

virtualSwitchId - string (typically in GUID format), obtained via a prior call to get the virtual switches. Do not populate when using TestRecovery. For ProductionRecovery this is mandatory.

cores - integer, CPU cores

memory - amount of memory in MB

revisions

Array of integers, representing the revisions to restore, obtained by a prior call to either Get volumes (for latest revision), or Get Revisions for volumes API call. Boot volumes must be part of those volumes, since the restore as VM requires boot volumes to be present.

skipValidations

Default is false. If not specified (which means false is implied), validations automatically run. While the validations can be run as separate API requests, they are also included by default as part of the API's processing of the Restore request.

However, since the validation calls are expensive, they can also be disabled in the Restore request (so a user can do them separately). This can be done via specifying "skipValidations": true in the request.