You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/virtual-machines/virtual-machines-create-restore-points.md
+47-7Lines changed: 47 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ ms.author: cynthn
6
6
ms.service: virtual-machines
7
7
ms.subservice: recovery
8
8
ms.topic: how-to
9
-
ms.date: 10/22/2021
9
+
ms.date: 02/14/2022
10
10
ms.custom: template-how-to
11
11
---
12
12
@@ -26,6 +26,8 @@ The following image illustrates the relationship between restore point collectio
26
26
27
27
:::image type="content" source="media/virtual-machines-create-restore-points-api/restore-point-hierarchy.png" alt-text="A diagram illustrating the relationship between the restore point collection parent and the restore point child objects.":::
28
28
29
+
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.
30
+
29
31
VM restore points are incremental. The first restore point stores a full copy of all disks attached to the VM. For each successive restore point for a VM, only the incremental changes to your disks are backed up. To reduce your costs, you can optionally exclude any disk when creating a restore point for your VM.
30
32
31
33
Keep the following restrictions in mind when you work with VM restore points:
@@ -34,26 +36,64 @@ Keep the following restrictions in mind when you work with VM restore points:
34
36
- Ultra disks, Ephemeral OS Disks, and Shared Disks aren't supported.
35
37
- The restore points APIs require API version 2021-03-01 or better.
36
38
- There is a limit of 200 VM restore points that can be created for a particular VM.
37
-
- Concurrent creation of restore points for a VM is not supported
39
+
- Concurrent creation of restore points for a VM is not supported.
40
+
- Private links are not supported when:
41
+
- Copying restore points across regions.
42
+
- Creating restore points in a region other than the source VM.
43
+
- Currently, cross-region creation and copy of VM restore points are only available in the following regions:
|**Americas**| East US, East US 2, Central US, North Central US, <br/>South Central US, West Central US, West US, West US 2 |
48
+
|**Asia Pacific**| Central India, South India |
49
+
|**Europe**| Germany West central, North Europe, West Europe |
38
50
39
51
## Create VM restore points
40
52
41
53
The following sections outline the steps you need to take to create VM restore points with the Azure Compute REST APIs.
42
54
43
-
You can find more information in the [Restore Points](/rest/api/compute/restore-points) and [Restore Point Collections](/rest/api/compute/restore-point-collections) API documentation.
55
+
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.
44
56
45
57
### Step 1: Create a VM restore point collection
46
58
47
-
Before you create VM restore points, you must create a restore point collection. A restore point collection holds all of the restore points for a specific VM.
48
-
59
+
Before you create VM restore points, you must create a restore point collection. A restore point collection holds all of 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.
60
+
To create a restore point collection, call the restore point collection's Create or Update API. 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. 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.
61
+
49
62
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.
50
63
51
64
### Step 2: Create a VM restore point
52
65
53
66
After the restore point collection is created, 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.
54
67
55
68
> [!TIP]
56
-
> To save space and costs, you can exclude any disk from your VM restore points. To exclude a disk, add its identifier to the `excludeDisks` property in the request body.
69
+
> 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.
70
+
71
+
### Step 3: Track the status of the VM restore point creation
72
+
73
+
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 within 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 created in a different region than the source VM.
74
+
75
+
## Copy a VM restore point between regions
76
+
77
+
The VM restore point APIs can be used to restore a VM in a different region than the source VM.
78
+
79
+
### Step 1: Create a destination VM restore point collection
80
+
81
+
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. Follow the guidance within the [Step 1: Create a VM restore point collection](#step-1-create-a-vm-restore-point-collection) section above.
82
+
83
+
### Step 2: Create the destination VM restore point
84
+
85
+
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. Ensure also that you've specified the source restore point's identifier in the request body. The source VM's location will be inferred from the target restore point collection in which the restore point is being created.
86
+
Refer to the [Restore Points - Create](/rest/api/compute/restore-points/create) API documentation to create a `RestorePoint`.
87
+
88
+
### Step 3: Track copy status
89
+
90
+
To track the status of the copy operation, follow the guidance within 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.
91
+
92
+
## Get restore point copy or replication status
93
+
94
+
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.
95
+
96
+
During restore point creation, the `ProvisioningState` will appear as `Creating` in the response. If creation fails, `ProvisioningState` will be set to `Failed`.
57
97
58
98
## Create a disk using disk restore points
59
99
@@ -79,4 +119,4 @@ For more information about granting access to snapshots, see the [Grant Access](
79
119
80
120
## Next steps
81
121
82
-
Read more about [Backup and restore options for virtual machines in Azure](backup-recovery.md).
122
+
Read more about [Backup and restore options for virtual machines in Azure](backup-recovery.md).
0 commit comments