Package com.azure.resourcemanager.recoveryservicesbackup.models

Class IaasVMRestoreRequest

java.lang.Object
com.azure.resourcemanager.recoveryservicesbackup.models.RestoreRequest
com.azure.resourcemanager.recoveryservicesbackup.models.IaasVMRestoreRequest
Direct Known Subclasses:
IaasVMRestoreWithRehydrationRequest
public class IaasVMRestoreRequest extends RestoreRequest
IaaS VM workload-specific restore.

  • Constructor Details

    • IaasVMRestoreRequest

      public IaasVMRestoreRequest()
      Creates an instance of IaasVMRestoreRequest class.

  • Method Details

    • recoveryPointId

      public String recoveryPointId()
      Get the recoveryPointId property: ID of the backup copy to be recovered.
      Returns:
      the recoveryPointId value.

    • withRecoveryPointId

      public IaasVMRestoreRequest withRecoveryPointId(String recoveryPointId)
      Set the recoveryPointId property: ID of the backup copy to be recovered.
      Parameters:
      recoveryPointId - the recoveryPointId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • recoveryType

      public RecoveryType recoveryType()
      Get the recoveryType property: Type of this recovery.
      Returns:
      the recoveryType value.

    • withRecoveryType

      public IaasVMRestoreRequest withRecoveryType(RecoveryType recoveryType)
      Set the recoveryType property: Type of this recovery.
      Parameters:
      recoveryType - the recoveryType value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • sourceResourceId

      public String sourceResourceId()
      Get the sourceResourceId property: Fully qualified ARM ID of the VM which is being recovered.
      Returns:
      the sourceResourceId value.

    • withSourceResourceId

      public IaasVMRestoreRequest withSourceResourceId(String sourceResourceId)
      Set the sourceResourceId property: Fully qualified ARM ID of the VM which is being recovered.
      Parameters:
      sourceResourceId - the sourceResourceId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • targetVirtualMachineId

      public String targetVirtualMachineId()
      Get the targetVirtualMachineId property: 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}.
      Returns:
      the targetVirtualMachineId value.

    • withTargetVirtualMachineId

      public IaasVMRestoreRequest withTargetVirtualMachineId(String targetVirtualMachineId)
      Set the targetVirtualMachineId property: 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}.
      Parameters:
      targetVirtualMachineId - the targetVirtualMachineId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • targetResourceGroupId

      public String targetResourceGroupId()
      Get the targetResourceGroupId property: 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}.
      Returns:
      the targetResourceGroupId value.

    • withTargetResourceGroupId

      public IaasVMRestoreRequest withTargetResourceGroupId(String targetResourceGroupId)
      Set the targetResourceGroupId property: 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}.
      Parameters:
      targetResourceGroupId - the targetResourceGroupId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • storageAccountId

      public String storageAccountId()
      Get the storageAccountId property: Fully qualified ARM ID of the storage account to which the VM has to be restored.
      Returns:
      the storageAccountId value.

    • withStorageAccountId

      public IaasVMRestoreRequest withStorageAccountId(String storageAccountId)
      Set the storageAccountId property: Fully qualified ARM ID of the storage account to which the VM has to be restored.
      Parameters:
      storageAccountId - the storageAccountId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • virtualNetworkId

      public String virtualNetworkId()
      Get the virtualNetworkId property: 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.
      Returns:
      the virtualNetworkId value.

    • withVirtualNetworkId

      public IaasVMRestoreRequest withVirtualNetworkId(String virtualNetworkId)
      Set the virtualNetworkId property: 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.
      Parameters:
      virtualNetworkId - the virtualNetworkId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • subnetId

      public String subnetId()
      Get the subnetId property: 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.
      Returns:
      the subnetId value.

    • withSubnetId

      public IaasVMRestoreRequest withSubnetId(String subnetId)
      Set the subnetId property: 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.
      Parameters:
      subnetId - the subnetId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • targetDomainNameId

      public String targetDomainNameId()
      Get the targetDomainNameId property: Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.
      Returns:
      the targetDomainNameId value.

    • withTargetDomainNameId

      public IaasVMRestoreRequest withTargetDomainNameId(String targetDomainNameId)
      Set the targetDomainNameId property: Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.
      Parameters:
      targetDomainNameId - the targetDomainNameId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • region

      public String region()
      Get the region property: Region in which the virtual machine is restored.
      Returns:
      the region value.

    • withRegion

      public IaasVMRestoreRequest withRegion(String region)
      Set the region property: Region in which the virtual machine is restored.
      Parameters:
      region - the region value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • affinityGroup

      public String affinityGroup()
      Get the affinityGroup property: Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.
      Returns:
      the affinityGroup value.

    • withAffinityGroup

      public IaasVMRestoreRequest withAffinityGroup(String affinityGroup)
      Set the affinityGroup property: Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.
      Parameters:
      affinityGroup - the affinityGroup value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • createNewCloudService

      public Boolean createNewCloudService()
      Get the createNewCloudService property: 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.
      Returns:
      the createNewCloudService value.

    • withCreateNewCloudService

      public IaasVMRestoreRequest withCreateNewCloudService(Boolean createNewCloudService)
      Set the createNewCloudService property: 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.
      Parameters:
      createNewCloudService - the createNewCloudService value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • originalStorageAccountOption

      public Boolean originalStorageAccountOption()
      Get the originalStorageAccountOption property: Original Storage Account Option.
      Returns:
      the originalStorageAccountOption value.

    • withOriginalStorageAccountOption

      public IaasVMRestoreRequest withOriginalStorageAccountOption(Boolean originalStorageAccountOption)
      Set the originalStorageAccountOption property: Original Storage Account Option.
      Parameters:
      originalStorageAccountOption - the originalStorageAccountOption value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • encryptionDetails

      public EncryptionDetails encryptionDetails()
      Get the encryptionDetails property: Details needed if the VM was encrypted at the time of backup.
      Returns:
      the encryptionDetails value.

    • withEncryptionDetails

      public IaasVMRestoreRequest withEncryptionDetails(EncryptionDetails encryptionDetails)
      Set the encryptionDetails property: Details needed if the VM was encrypted at the time of backup.
      Parameters:
      encryptionDetails - the encryptionDetails value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • restoreDiskLunList

      public List<Integer> restoreDiskLunList()
      Get the restoreDiskLunList property: List of Disk LUNs for partial restore.
      Returns:
      the restoreDiskLunList value.

    • withRestoreDiskLunList

      public IaasVMRestoreRequest withRestoreDiskLunList(List<Integer> restoreDiskLunList)
      Set the restoreDiskLunList property: List of Disk LUNs for partial restore.
      Parameters:
      restoreDiskLunList - the restoreDiskLunList value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • restoreWithManagedDisks

      public Boolean restoreWithManagedDisks()
      Get the restoreWithManagedDisks property: Flag to denote of an Unmanaged disk VM should be restored with Managed disks.
      Returns:
      the restoreWithManagedDisks value.

    • withRestoreWithManagedDisks

      public IaasVMRestoreRequest withRestoreWithManagedDisks(Boolean restoreWithManagedDisks)
      Set the restoreWithManagedDisks property: Flag to denote of an Unmanaged disk VM should be restored with Managed disks.
      Parameters:
      restoreWithManagedDisks - the restoreWithManagedDisks value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • diskEncryptionSetId

      public String diskEncryptionSetId()
      Get the diskEncryptionSetId property: DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.
      Returns:
      the diskEncryptionSetId value.

    • withDiskEncryptionSetId

      public IaasVMRestoreRequest withDiskEncryptionSetId(String diskEncryptionSetId)
      Set the diskEncryptionSetId property: DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.
      Parameters:
      diskEncryptionSetId - the diskEncryptionSetId value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • zones

      public List<String> zones()
      Get the zones property: Target zone where the VM and its disks should be restored.
      Returns:
      the zones value.

    • withZones

      public IaasVMRestoreRequest withZones(List<String> zones)
      Set the zones property: Target zone where the VM and its disks should be restored.
      Parameters:
      zones - the zones value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • identityInfo

      public IdentityInfo identityInfo()
      Get the identityInfo property: Managed Identity information required to access customer storage account.
      Returns:
      the identityInfo value.

    • withIdentityInfo

      public IaasVMRestoreRequest withIdentityInfo(IdentityInfo identityInfo)
      Set the identityInfo property: Managed Identity information required to access customer storage account.
      Parameters:
      identityInfo - the identityInfo value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • identityBasedRestoreDetails

      public IdentityBasedRestoreDetails identityBasedRestoreDetails()
      Get the identityBasedRestoreDetails property: IaaS VM workload specific restore details for restores using managed identity.
      Returns:
      the identityBasedRestoreDetails value.

    • withIdentityBasedRestoreDetails

      public IaasVMRestoreRequest withIdentityBasedRestoreDetails(IdentityBasedRestoreDetails identityBasedRestoreDetails)
      Set the identityBasedRestoreDetails property: IaaS VM workload specific restore details for restores using managed identity.
      Parameters:
      identityBasedRestoreDetails - the identityBasedRestoreDetails value to set.
      Returns:
      the IaasVMRestoreRequest object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RestoreRequest
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.