Skip to content

Commit 674cbd5

Browse files
authored
Merge pull request #205051 from MicrosoftDocs/release-restorepoints-ga
Release restorepoints ga--scheduled release at 8AM of 7/19
2 parents d874d32 + b67bfe2 commit 674cbd5

23 files changed

+885
-94
lines changed

articles/virtual-machines/TOC.yml

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1941,8 +1941,6 @@
19411941
- name: Overview
19421942
href: ../backup/backup-azure-vms-introduction.md?context=/azure/virtual-machines/context/context
19431943
dispayName: backup VMs, Azure Backup, recovery
1944-
- name: Creating restore points
1945-
href: virtual-machines-create-restore-points.md
19461944
- name: Quickstarts
19471945
items:
19481946
- name: CLI
@@ -1987,6 +1985,28 @@
19871985
href: ../site-recovery/azure-to-azure-tutorial-failover-failback.md?context=/azure/virtual-machines/context/context
19881986
- name: Fail back a VM to the primary region
19891987
href: ../site-recovery/azure-to-azure-tutorial-failback.md?context=/azure/virtual-machines/context/context
1988+
- name: VM restore points
1989+
items:
1990+
- name: Overview
1991+
href: virtual-machines-create-restore-points.md
1992+
- name: Quickstarts
1993+
items:
1994+
- name: Create VM restore points
1995+
href: create-restore-points.md
1996+
- name: Manage VM restore points
1997+
href: manage-restore-points.md
1998+
- name: Tutorials
1999+
items:
2000+
- name: CLI
2001+
href: virtual-machines-create-restore-points-cli.md
2002+
- name: PowerShell
2003+
href: virtual-machines-create-restore-points-powershell.md
2004+
- name: Portal
2005+
href: virtual-machines-create-restore-points-portal.md
2006+
- name: Support matrix
2007+
href: concepts-restore-points.md
2008+
- name: Troubleshooting
2009+
href: restore-point-troubleshooting.md
19902010
- name: Move and migrate VMs
19912011
items:
19922012
- name: Change subscription or resource group
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Support matrix for VM restore points
3+
description: Support matrix for VM restore points
4+
author: dikethir
5+
ms.author: dikethir
6+
ms.service: virtual-machines
7+
ms.topic: conceptual
8+
ms.date: 07/05/2022
9+
ms.custom: template-concept
10+
---
11+
12+
# Support matrix for VM restore points
13+
14+
This article summarizes the support matrix and limitations of using [VM restore points](virtual-machines-create-restore-points.md).
15+
16+
17+
## VM restore points support matrix
18+
19+
The following table summarizes the support matrix for VM restore points.
20+
21+
**Scenarios** | **Supported by VM restore points**
22+
--- | ---
23+
**VMs using Managed disks** | Yes
24+
**VMs using unmanaged disks** | No
25+
**VMs using Ultra Disks** | No. Exclude these disks and create a VM restore point.
26+
**VMs using Ephemeral OS Disks** | No. Exclude these disks and create a VM restore point.
27+
**VMs using shared disks** | No. Exclude these disks and create a VM restore point.
28+
**VMs with extensions** | Yes
29+
**VMs with trusted launch** | Yes
30+
**Confidential VMs** | Yes
31+
**Generation 2 VMs (UEFI boot)** | Yes
32+
**VMs with NVMe disks (Storage optimized - Lsv2-series)** | Yes
33+
**VMs in Proximity placement groups** | Yes
34+
**VMs in an availability set** | Yes. You can create VM restore points for individual VMs within an availability set. You need to create restore points for all the VMs within an availability set to protect an entire availability set instance.
35+
**VMs inside VMSS with uniform orchestration** | No
36+
**VMs inside VMSS with flexible orchestration** | Yes. You can create VM restore points for individual VMs within the virtual machine scale set flex. However, you need to create restore points for all the VMs within the virtual machine scale set flex to protect an entire virtual machine scale set flex instance.
37+
**Spot VMs (Low priority VMs)** | Yes
38+
**VMs with dedicated hosts** | Yes
39+
**VMs with Host caching enabled** | Yes
40+
**VMs created from marketplace images** | Yes
41+
**VMs created from custom images** | Yes
42+
**VM with HUB (Hybrid Use Benefit) license** | Yes
43+
**VMs migrated from on-prem using Azure Migrate** | Yes
44+
**VMs with RBAC policies** | Yes
45+
**Temporary disk in VMs** | Yes. You can create VM restore point for VMs with temporary disks. However, the restore points created don't contain the data from the temporary disks.
46+
**VMs with standard HDDs** | Yes
47+
**VMs with standard SSDs** | Yes
48+
**VMs with premium SSDs** | Yes
49+
**VMs with ZRS disks** | Yes
50+
**VMs with server-side encryption using service-managed keys** | Yes
51+
**VMs with server-side encryption using customer-managed keys** | Yes
52+
**VMs with double encryption at rest** | Yes
53+
**VMs with Host based encryption enabled with PMK/CMK/Double encryption** | Yes
54+
**VMs with ADE (Azure Disk Encryption)** | Yes
55+
**VMs using Accelerated Networking** | Yes
56+
**Frequency supported** | Three hours for app consistent restore points. One hour for [crash consistent restore points (preview)](https://github.com/Azure/Virtual-Machine-Restore-Points/tree/main/Crash%20consistent%20VM%20restore%20points%20(preview))
57+
58+
## Operating system support
59+
60+
### Windows
61+
62+
The following Windows operating systems are supported when creating restore points for Azure VMs running on Windows.
63+
64+
- Windows 10 Client (64 bit only)
65+
- Windows Server 2022 (Datacenter/Datacenter Core/Standard)
66+
- Windows Server 2019 (Datacenter/Datacenter Core/Standard)
67+
- Windows Server 2016 (Datacenter/Datacenter Core/Standard)
68+
- Windows Server 2012 R2 (Datacenter/Standard)
69+
- Windows Server 2012 (Datacenter/Standard)
70+
- Windows Server 2008 R2 (RTM and SP1 Standard)
71+
- Windows Server 2008 (64 bit only)
72+
73+
Restore points don't support 32-bit operating systems.
74+
75+
### Linux
76+
77+
For Azure VM Linux VMs, restore points support the list of Linux [distributions endorsed by Azure](../virtual-machines/linux/endorsed-distros.md). Note the following:
78+
79+
- Restore points don't support Core OS Linux.
80+
- Restore points don't support 32-bit operating systems.
81+
- Other bring-your-own Linux distributions might work as long as the [Azure VM agent for Linux](../virtual-machines/extensions/agent-linux.md) is available on the VM, and as long as Python is supported.
82+
- Restore points don't support a proxy-configured Linux VM if it doesn't have Python version 2.7 or higher installed.
83+
- Restore points don't back up NFS files that are mounted from storage, or from any other NFS server, to Linux or Windows machines. It only backs up disks that are locally attached to the VM.
84+
85+
## Other limitations
86+
87+
- Restore points are supported only for managed disks.
88+
- Ultra-disks, Ephemeral OS disks, and Shared disks aren't supported.
89+
- Restore points APIs require an API of version 2021-03-01 or later.
90+
- A maximum of 500 VM restore points can be retained at any time for a VM, irrespective of the number of restore point collections.
91+
- Concurrent creation of restore points for a VM isn't supported.
92+
- Movement of Virtual Machines (VM) between Resource Groups (RG), or Subscriptions isn't supported when the VM has restore points. Moving the VM between Resource Groups or Subscriptions won't update the source VM reference in the restore point and will cause a mismatch of ARM processor IDs between the actual VM and the restore points.
93+
> [!Note]
94+
> Public preview of cross-region creation and copying of VM restore points is available, with the following limitations:
95+
> - Private links aren't supported when copying restore points across regions or creating restore points in a region other than the source VM.
96+
> - Customer-managed key encrypted restore points, when copied to a target region or created directly in the target region are created as platform-managed key encrypted restore points.
97+
> - No portal support for cross region copy and cross region creation of restore points
98+
99+
## Next steps
100+
101+
- Learn how to create VM restore points using [CLI](virtual-machines-create-restore-points-cli.md), [Azure portal](virtual-machines-create-restore-points-portal.md), and [PowerShell](virtual-machines-create-restore-points-powershell.md).
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Create Virtual Machine restore points
3+
description: Creating Virtual Machine Restore Points with API
4+
author: dikethir
5+
ms.author: dikethir
6+
ms.service: virtual-machines
7+
ms.subservice: recovery
8+
ms.date: 02/14/2022
9+
ms.topic: quickstart
10+
ms.custom: template-quickstart
11+
---
12+
13+
# Quickstart: Create VM restore points using APIs
14+
15+
You can protect your data by taking backups at regular intervals. Azure VM restore point APIs are a lightweight option you can use to implement granular backup and retention policies. VM restore points support application consistency for VMs running Windows operating systems and support file system consistency for VMs running Linux operating system.
16+
17+
You can use the APIs to create restore points for your source VM in either the same region, or in other regions. You can also copy existing VM restore points between regions.
18+
19+
## Prerequisites
20+
21+
- [Learn more](concepts-restore-points.md) about the requirements for a VM restore point.
22+
- Consider the [limitations](virtual-machines-create-restore-points.md#limitations) before creating a restore point.
23+
24+
## Create VM restore points
25+
26+
The following sections outline the steps you need to take to create VM restore points with the Azure Compute REST APIs.
27+
28+
You can find more information in the [Restore Points](/rest/api/compute/restore-points), [PowerShell](/powershell/module/az.compute/new-azrestorepoint), and [Restore Point Collections](/rest/api/compute/restore-point-collections) API documentation.
29+
30+
### Step 1: Create a VM restore point collection
31+
32+
Before you create VM restore points, you must create a restore point collection. A restore point collection holds all the restore points for a specific VM. Depending on your needs, you can create VM restore points in the same region as the VM, or in a different region.
33+
To create a restore point collection, call the restore point collection's Create or Update API.
34+
- If you're creating restore point collection in the same region as the VM, then specify the VM's region in the location property of the request body.
35+
- If you're creating the restore point collection in a different region than the VM, specify the target region for the collection in the location property, but also specify the source restore point collection ARM resource ID in the request body.
36+
37+
To create a restore point collection, call the restore point collection's [Create or Update](/rest/api/compute/restore-point-collections/create-or-update) API.
38+
39+
### Step 2: Create a VM restore point
40+
41+
After you create the restore point collection, the next step is to create a VM restore point within the restore point collection. For more information about restore point creation, see the [Restore Points - Create](/rest/api/compute/restore-points/create) API documentation.
42+
43+
> [!TIP]
44+
> To save space and costs, you can exclude any disk from either local region or cross-region VM restore points. To exclude a disk, add its identifier to the `excludeDisks` property in the request body.
45+
46+
### Step 3: Track the status of the VM restore point creation
47+
48+
Restore point creation in your local region will be completed within a few seconds. Scenarios, which involve the creation of cross-region restore points will take considerably longer. To track the status of the creation operation, follow the guidance in [Get restore point copy or replication status](#get-restore-point-copy-or-replication-status). This is only applicable for scenarios where the restore points are created in a different region than the source VM.
49+
50+
## Get restore point copy or replication status
51+
52+
Creation of a cross-region VM restore point is a long running operation. The VM restore point can be used to restore a VM only after the operation is completed for all disk restore points. To track the operation's status, call the [Restore Point - Get](/rest/api/compute/restore-points/get) API on the target VM restore point and include the `instanceView` parameter. The return will include the percentage of data that has been copied at the time of the request.
53+
54+
During restore point creation, the `ProvisioningState` will appear as `Creating` in the response. If creation fails, `ProvisioningState` is set to `Failed`.
55+
56+
## Next steps
57+
- [Learn more](manage-restore-points.md) about managing restore points.
58+
- Create restore points using the [Azure portal](virtual-machines-create-restore-points-portal.md), [CLI](virtual-machines-create-restore-points-cli.md), or [PowerShell](virtual-machines-create-restore-points-powershell.md).
59+
- [Learn more](backup-recovery.md) about Backup and restore options for virtual machines in Azure.

articles/virtual-machines/index.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ landingContent:
2929
url: trusted-launch.md
3030
- text: VM applications in Azure Compute Gallery
3131
url: vm-applications.md
32+
- text: VM restore points
33+
url: virtual-machines-create-restore-points.md
3234

3335
# Card (optional)
3436
- title: Linux quickstarts
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Manage Virtual Machine restore points
3+
description: Managing Virtual Machine Restore Points
4+
author: dikethir
5+
ms.author: dikethir
6+
ms.service: virtual-machines
7+
ms.subservice: recovery
8+
ms.topic: how-to
9+
ms.date: 07/05/2022
10+
ms.custom: template-how-to
11+
---
12+
13+
# Manage VM restore points
14+
15+
This article explains how to copy and restore a VM from a VM restore point and track the progress of the copy operation. This article also explains how to create a disk from a disk restore point and to create a shared access signature for a disk.
16+
17+
## Copy a VM restore point between regions
18+
19+
The VM restore point APIs can be used to restore a VM in a different region than the source VM.
20+
Use the following steps:
21+
22+
### Step 1: Create a destination VM restore point collection
23+
24+
To copy an existing VM restore point from one region to another, your first step is to create a restore point collection in the target or destination region. To do this, reference the restore point collection from the source region as detailed in [Create a VM restore point collection](create-restore-points.md#step-1-create-a-vm-restore-point-collection).
25+
26+
### Step 2: Create the destination VM restore point
27+
28+
After the restore point collection is created, trigger the creation of a restore point in the target restore point collection. Ensure that you've referenced the restore point in the source region that you want to copy and specified the source restore point's identifier in the request body. The source VM's location is inferred from the target restore point collection in which the restore point is being created.
29+
See the [Restore Points - Create](/rest/api/compute/restore-points/create) API documentation to create a `RestorePoint`.
30+
31+
### Step 3: Track copy status
32+
33+
To track the status of the copy operation, follow the guidance in the [Get restore point copy or replication status](#get-restore-point-copy-or-replication-status) section below. This is only applicable for scenarios where the restore points are copied to a different region than the source VM.
34+
35+
## Get restore point copy or replication status
36+
37+
Creation of a cross-region VM restore point is a long running operation. The VM restore point can be used to restore a VM only after the operation is completed for all disk restore points. To track the operation's status, call the [Restore Point - Get](/rest/api/compute/restore-points/get) API on the target VM restore point and include the `instanceView` parameter. The return will include the percentage of data that has been copied at the time of the request.
38+
39+
During restore point creation, the `ProvisioningState` will appear as `Creating` in the response. If creation fails, `ProvisioningState` is set to `Failed`.
40+
41+
## Create a disk using disk restore points
42+
43+
You can use the VM restore points APIs to restore a VM disk, which can then be used to create a new VM.
44+
Use the following steps:
45+
46+
### Step 1: Retrieve disk restore point identifiers
47+
48+
Call the [Restore Point Collections - Get](/rest/api/compute/restore-point-collections/get) API on the restore point collection to get access to associated restore points and their IDs. Each VM restore point will in turn contain individual disk restore point identifiers.
49+
50+
### Step 2: Create a disk
51+
52+
After you have the list of disk restore point IDs, you can use the [Disks - Create Or Update](/rest/api/compute/disks/create-or-update) API to create a disk from the disk restore points.
53+
54+
## Restore a VM with a restore point
55+
56+
To restore a full VM from a VM restore point, you must restore individual disks from each disk restore point. This process is described in the [Create a disk](#create-a-disk-using-disk-restore-points) section. After you restore all the disks, create a new VM and attach the restored disks to the new VM.
57+
You can also use the [ARM template](https://github.com/Azure/Virtual-Machine-Restore-Points/blob/main/RestoreVMFromRestorePoint.json) to restore a full VM along with all the disks.
58+
59+
## Get a shared access signature for a disk
60+
61+
To create a Shared Access Signature (SAS) for a disk within a VM restore point, pass the ID of the disk restore points via the `BeginGetAccess` API. If no active SAS exists on the restore point snapshot, a new SAS is created. The new SAS URL is returned in the response. If an active SAS already exists, the SAS duration is extended, and the pre-existing SAS URL is returned in the response.
62+
63+
For more information about granting access to snapshots, see the [Grant Access](/rest/api/compute/snapshots/grant-access) API documentation.
64+
65+
## Next steps
66+
67+
[Learn more](backup-recovery.md) about Backup and restore options for virtual machines in Azure.
73.7 KB
Loading
73.7 KB
Loading
140 KB
Loading
93.5 KB
Loading
Loading

0 commit comments

Comments
 (0)