---
title: VZMacOSRestoreImage
framework: virtualization
role: symbol
role_heading: Class
path: virtualization/vzmacosrestoreimage
---

# VZMacOSRestoreImage

An object that describes a version of macOS to install on to a virtual machine.

## Declaration

```swift
class VZMacOSRestoreImage
```

## Mentioned in

Installing macOS on a Virtual Machine Using iCloud with macOS virtual machines

## Overview

Overview To set up a new VM compatible with the restore image, use mostFeaturefulSupportedConfiguration to obtain the hardwareModel of the VZMacPlatformConfiguration. Then, create a VZMacOSRestoreImage object by loading an installation media file. Initialize a VZMacOSInstaller object with this VZMacOSRestoreImage object to install the operating system onto a VM. important: Loading a restore image requires the app to have the com.apple.security.virtualization entitlement.

## Topics

### Getting Information About the Restore Image

- [buildVersion](virtualization/vzmacosrestoreimage/buildversion.md)
- [isSupported](virtualization/vzmacosrestoreimage/issupported.md)
- [mostFeaturefulSupportedConfiguration](virtualization/vzmacosrestoreimage/mostfeaturefulsupportedconfiguration.md)
- [operatingSystemVersion](virtualization/vzmacosrestoreimage/operatingsystemversion.md)
- [url](virtualization/vzmacosrestoreimage/url.md)

### Controlling the Restoration Process

- [fetchLatestSupported(completionHandler:)](virtualization/vzmacosrestoreimage/fetchlatestsupported(completionhandler:).md)
- [load(from:completionHandler:)](virtualization/vzmacosrestoreimage/load(from:completionhandler:).md)
- [latestSupported](virtualization/vzmacosrestoreimage/latestsupported.md)
- [image(from:)](virtualization/vzmacosrestoreimage/image(from:).md)

## Relationships

### Inherits From

- [NSObject](objectivec/nsobject-swift.class.md)

### Conforms To

- [CVarArg](swift/cvararg.md)
- [CustomDebugStringConvertible](swift/customdebugstringconvertible.md)
- [CustomStringConvertible](swift/customstringconvertible.md)
- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)

## See Also

### Related Documentation

- [VZMacHardwareModel](virtualization/vzmachardwaremodel.md)

### Installers

- [VZMacOSInstaller](virtualization/vzmacosinstaller.md)
- [VZMacOSConfigurationRequirements](virtualization/vzmacosconfigurationrequirements.md)