IaasVMRestoreRequest interface
IaaS VM workload-specific restore.
- Extends
Properties
affinity |
Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines. |
create |
Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same cloud service as it was at the time of backup. |
disk |
DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key. |
encryption |
Details needed if the VM was encrypted at the time of backup. |
extended |
Target extended location where the VM should be restored, should be null if restore is to be done in public cloud |
identity |
IaaS VM workload specific restore details for restores using managed identity. |
identity |
Managed Identity information required to access customer storage account. |
object |
Polymorphic discriminator, which specifies the different types this object can be |
original |
Original Storage Account Option |
recovery |
ID of the backup copy to be recovered. |
recovery |
Type of this recovery. |
region | Region in which the virtual machine is restored. |
restore |
List of Disk LUNs for partial restore |
restore |
Flag to denote of an Unmanaged disk VM should be restored with Managed disks. |
secured |
Stores Secured VM Details |
source |
Fully qualified ARM ID of the VM which is being recovered. |
storage |
Fully qualified ARM ID of the storage account to which the VM has to be restored. |
subnet |
Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent the subnet. |
target |
Specifies target network access settings for disks of VM to be restored, |
target |
Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines. |
target |
This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts. For e.g. /subscriptions/{subId}/resourcegroups/{rg} |
target |
This is the complete ARM Id of the VM that will be created. For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm} |
virtual |
This is the virtual network Id of the vnet that will be attached to the virtual machine. User will be validated for join action permissions in the linked access. |
zones | Target zone where the VM and its disks should be restored. |
Inherited Properties
resource |
ResourceGuardOperationRequests on which LAC check will be performed |
Property Details
affinityGroup
Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.
affinityGroup?: string
Property Value
string
createNewCloudService
Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same cloud service as it was at the time of backup.
createNewCloudService?: boolean
Property Value
boolean
diskEncryptionSetId
DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.
diskEncryptionSetId?: string
Property Value
string
encryptionDetails
Details needed if the VM was encrypted at the time of backup.
encryptionDetails?: EncryptionDetails
Property Value
extendedLocation
Target extended location where the VM should be restored, should be null if restore is to be done in public cloud
extendedLocation?: ExtendedLocation
Property Value
identityBasedRestoreDetails
IaaS VM workload specific restore details for restores using managed identity.
identityBasedRestoreDetails?: IdentityBasedRestoreDetails
Property Value
identityInfo
Managed Identity information required to access customer storage account.
identityInfo?: IdentityInfo
Property Value
objectType
Polymorphic discriminator, which specifies the different types this object can be
objectType: "IaasVMRestoreRequest" | "IaasVMRestoreWithRehydrationRequest"
Property Value
"IaasVMRestoreRequest" | "IaasVMRestoreWithRehydrationRequest"
originalStorageAccountOption
Original Storage Account Option
originalStorageAccountOption?: boolean
Property Value
boolean
recoveryPointId
ID of the backup copy to be recovered.
recoveryPointId?: string
Property Value
string
recoveryType
Type of this recovery.
recoveryType?: string
Property Value
string
region
Region in which the virtual machine is restored.
region?: string
Property Value
string
restoreDiskLunList
List of Disk LUNs for partial restore
restoreDiskLunList?: number[]
Property Value
number[]
restoreWithManagedDisks
Flag to denote of an Unmanaged disk VM should be restored with Managed disks.
restoreWithManagedDisks?: boolean
Property Value
boolean
securedVMDetails
sourceResourceId
Fully qualified ARM ID of the VM which is being recovered.
sourceResourceId?: string
Property Value
string
storageAccountId
Fully qualified ARM ID of the storage account to which the VM has to be restored.
storageAccountId?: string
Property Value
string
subnetId
Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent the subnet.
subnetId?: string
Property Value
string
targetDiskNetworkAccessSettings
Specifies target network access settings for disks of VM to be restored,
targetDiskNetworkAccessSettings?: TargetDiskNetworkAccessSettings
Property Value
targetDomainNameId
Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.
targetDomainNameId?: string
Property Value
string
targetResourceGroupId
This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts. For e.g. /subscriptions/{subId}/resourcegroups/{rg}
targetResourceGroupId?: string
Property Value
string
targetVirtualMachineId
This is the complete ARM Id of the VM that will be created. For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
targetVirtualMachineId?: string
Property Value
string
virtualNetworkId
This is the virtual network Id of the vnet that will be attached to the virtual machine. User will be validated for join action permissions in the linked access.
virtualNetworkId?: string
Property Value
string
zones
Target zone where the VM and its disks should be restored.
zones?: string[]
Property Value
string[]
Inherited Property Details
resourceGuardOperationRequests
ResourceGuardOperationRequests on which LAC check will be performed
resourceGuardOperationRequests?: string[]
Property Value
string[]
Inherited From RestoreRequest.resourceGuardOperationRequests