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
Add notice on GetMigrationJobProgress to AMR API overview (SharePoint#10340)
* Create migration-job-progress-api-reference.md
* Update migration-job-progress-api-reference.md
* Update migration-job-progress-api-reference.md
Revised broken links
* Update migration-job-progress-api-reference.md
Replace with relative links
* fix markdown issues, grammar, typos
## markdown
in accordance with msdocs guidelines, applied the following changes:
- always have empty lines between headings, paragraphs, and fenced code blocks
- fenced code language fixes:
- no such language **rest**... changed to `http` or `json` where applicable
- used inline formatting where applicable
* Add notice on GetMigrationJobProgress API
* Add notice on GetMigrationJobProgress API in Migration API Reference
* update doc date
* update doc date
* Add notice of GetMigrationJobProgress to AMR API overview
* markdown formatting & grammar fixes
* markdown formatting & grammar fixes
WRT markdown, for blockquotes, new ilnes shoudl be seperated by an empty line
---------
Co-authored-by: Andrew Connell <[email protected]>
Copy file name to clipboardExpand all lines: docs/apis/export-amr-api.md
+20-10Lines changed: 20 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: "SharePoint Asynchronous Metadata Read (AMR) API Introduction"
3
-
description: This document is an overview on how to read metadata from SharePoint, targeted to SharePoint migration tool developers.
4
-
ms.date: 04/18/2024
3
+
description: Overview how to read metadata from SharePoint, targeted to SharePoint migration tool developers.
4
+
ms.date: 07/23/2025
5
5
ms.author: ranren
6
6
author: underreview
7
7
manager: dapodean
@@ -15,9 +15,9 @@ ms.collection:
15
15
---
16
16
# SharePoint Asynchronous Metadata Read (AMR) API Introduction
17
17
18
-
The SharePoint Asynchronous Metadata Read (AMR) API asynchronously exports metadata from SharePoint and OneDrive.
18
+
The SharePoint Asynchronous Metadata Read (AMR) API enables the asynchronous export of metadata from SharePoint and OneDrive.
19
19
20
-
Use AMR API to export metadata from SharePoint, for incremental migration, and post-migration validation.
20
+
Use AMR API to export metadata from SharePoint for incremental migration and post-migration validation.
21
21
22
22
AMR is designed exclusively for import scenarios. It exhibits poor scalability when handling requests for metadata, permissions, or versions. We can't provide performance assurances for AMR usage in data export scenarios, such as cross-tenant migrations.
23
23
@@ -33,6 +33,11 @@ Export metadata from SharePoint in three steps:
33
33
34
34
### Provision the destination containers and the queue
35
35
36
+
> [!IMPORTANT]
37
+
> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status.
38
+
>
39
+
> Provisioning Azure Queues for migration job status tracking is no longer required. Deprecation of Azure Queues is planned for the second half of 2026. Until then, Azure Queues will remain available for status retrieval.
40
+
36
41
Use `ProvisionMigrationContainers` method to provision the containers. Check [Use Azure Blob Storage Containers and Azure Queues with Migration API](migration-azure.md) for details. You can also use your own containers and queues if needed.
37
42
38
43
### Use `CreateSPAsyncReadJob` method to start the export
@@ -47,19 +52,24 @@ Check [AMR API Reference](amr-api-reference.md) for details.
47
52
48
53
### Checking status
49
54
55
+
> [!IMPORTANT]
56
+
> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status.
57
+
>
58
+
> Provisioning Azure Queues for migration job status tracking is no longer required. Deprecation of Azure Queues is planned for the second half of 2026. Until then, Azure Queues will remain available for status retrieval.
59
+
50
60
Check Azure Queue supplied for export status. Monitor events as listed in [Events](migration-events.md) for details.
51
61
52
-
AMR API exports metadata in the manifest container supplied, under folder named by `JobID`. Check [Manifest files](migration-manifest.md) for the format and validation of the metadata.
62
+
AMR API exports metadata in the manifest container supplied, under a folder named by `JobID`. Check [Manifest files](migration-manifest.md) for the format and validation of the metadata.
53
63
54
-
AMR API splits manifest package larger than 25 MB into multiple manifest files per request.
64
+
AMR API splits manifest packages larger than 25 MB into multiple manifest files per request.
55
65
56
66
## Best practice
57
67
58
68
AMR API is powerful. Ensure good performance to achieve the scale for large migration projects.
59
69
60
70
### Export security and permissions on top level if possible
61
71
62
-
Exporting security with `IncludeSecurity` consumes more resources and slows down the export. It's faster to export these metadata at upper-level folder first, then export the children without them.
72
+
Exporting security with `IncludeSecurity` consumes more resources and slows down the export. It's faster to export this metadata at the upper-level folder first, then export the children without them.
63
73
64
74
### Metadata export on a single item
65
75
@@ -90,9 +100,9 @@ AMR API processes jobs through a queue mechanism with preconfigured workload man
90
100
91
101
### Lab-tested performance baseline
92
102
93
-
We tested the performance in lab setting. AMR API exported about 400 items per second for every 250-K objects, in the average case. The peak performance reached 700 items per second.
103
+
We tested the performance in a lab setting. AMR API exported about 400 items per second for every 250-K objects, in the average case. The peak performance reached 700 items per second.
94
104
95
-
There are multiple factors that affect the real-life performance. These factors include:
105
+
Multiple factors affect real-life performance. These factors include:
96
106
97
107
- The number of items that are being exported
98
108
- The way AMR API is implemented
@@ -108,6 +118,6 @@ To ensure good user experiences for all Microsoft 365 customers, SharePoint uses
108
118
109
119
### Tenant-to-Tenant migrations
110
120
111
-
AMR isn't intended for scenario where contents from a SharePoint tenant are moved to another. This type of migration requires the use of many resource-heavy read options. The long processing time of these read options slows down the overall migration significantly.
121
+
AMR isn't intended for scenarios where contents from a SharePoint tenant are moved to another. This type of migration requires the use of many resource-heavy read options. The long processing time of these read options slows down the overall migration significantly.
112
122
113
123
Microsoft provides no performance guarantee in this scenario. Use Graph or CSOM as needed.
Copy file name to clipboardExpand all lines: docs/apis/migration-api-overview.md
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "SharePoint Import Migration API"
3
-
description: "This article provides overview information on how to use the SharePoint Migration API."
3
+
description: "This article provides an overview of how to use the SharePoint Migration API."
4
4
ms.date: 07/16/2025
5
5
ms.author: ranren
6
6
author: underreview
@@ -15,7 +15,7 @@ ms.collection:
15
15
---
16
16
# SharePoint Migration API Introduction
17
17
18
-
The SharePoint Migration API imports contents into SharePoint at scale. It processes content and manifest packages as jobs in a queue. The API provides process status and logs, making it easy to monitor the progress of each migration job.
18
+
The SharePoint Migration API imports content into SharePoint at scale. It processes content and manifest packages as jobs in a queue. The API provides process status and logs, making it easy to monitor the progress of each migration job.
19
19
20
20
Use Migration API to migrate content from file shares, SharePoint Server, and other cloud-based services.
21
21
@@ -27,7 +27,7 @@ We applied quota on *Share with Me* items per user. Check [ShareWithMe event quo
27
27
28
28
### November 2024
29
29
30
-
Migration API supports generating logs of all file-level events during migration to support auditing.
30
+
We enabled logging all file-level events during migration, such as file deletion, to support auditing.
31
31
32
32
### July 2024
33
33
@@ -48,7 +48,8 @@ Start a migration job with three steps. Check the guidance in each of the steps
48
48
### Provision the destination containers and the queue
49
49
50
50
> [!IMPORTANT]
51
-
> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status.
51
+
> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status.
52
+
>
52
53
> Provisioning Azure Queues for migration job status tracking is no longer required. Deprecation is planned for the second half of 2026. Until then, Azure Queues will remain available for status retrieval.
53
54
54
55
Use the `ProvisionMigrationContainers` method to provision the containers. Check [Use Azure Blob Storage Containers and Azure Queues with Migration API](migration-azure.md) for details. You can also use your own containers and queues if needed.
@@ -86,7 +87,7 @@ Migration generates workload to the SharePoint backend differently from end user
86
87
87
88
Don't use user mode in your migration solution. Running migration in user mode triggers increased throttling, resulting in poor performance.
88
89
89
-
To learn more on how to register an app ID and how to implement app-based authentication, check [How to register an app ID](/azure/active-directory/develop/active-directory-v2-registration-portal) and [Microsoft Graph Auth guidance](/graph/auth).
90
+
To learn more about how to register an app ID and how to implement app-based authentication, check [How to register an app ID](/azure/active-directory/develop/active-directory-v2-registration-portal) and [Microsoft Graph Auth guidance](/graph/auth).
90
91
91
92
### Microsoft Entra ID Permissions
92
93
@@ -95,17 +96,17 @@ Permissions and consent in the Azure Active Directory v1.0 endpoint](/azure/acti
95
96
96
97
For SharePoint and OneDrive migration scenarios, follow the Microsoft Entra ID permission specification.
97
98
98
-
For migration tools that rely on end-user signed in and presence, use Delegated permission.
99
+
For migration tools that rely on end-user sign-in and presence, use Delegated permission.
99
100
100
101
For service-based migration tools that run without a signed-in user present, such as applications that run as background services, use Application permission.
101
102
102
103
### App IDs
103
104
104
-
You can choose to share a single App ID to cover multiple migration solutions created or create individual App ID for each of the products. Make sure to register App IDs. Sharing App IDs doesn't affect performance or throttling.
105
+
You can choose to share a single App ID to cover multiple migration solutions created or create an individual App ID for each of the products. Make sure to register App IDs. Sharing App IDs doesn't affect performance or throttling.
105
106
106
107
### Keep destination SharePoint Site unactivated
107
108
108
-
To avoid migration issues, deactivate the target site for users until the migration completion. The source could remain active, allowing read and write to keep productivity. Switch users to the new SharePoint destination sites after migration completion.
109
+
To avoid migration issues, deactivate the target site for users until migration completion. The source could remain active, allowing read and write access to keep productivity. Switch users to the new SharePoint destination sites after migration completion.
0 commit comments