Skip to content

Commit 9cc569e

Browse files
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]>
1 parent 787f305 commit 9cc569e

File tree

2 files changed

+29
-18
lines changed

2 files changed

+29
-18
lines changed

docs/apis/export-amr-api.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
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
55
ms.author: ranren
66
author: underreview
77
manager: dapodean
@@ -15,9 +15,9 @@ ms.collection:
1515
---
1616
# SharePoint Asynchronous Metadata Read (AMR) API Introduction
1717

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.
1919

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.
2121

2222
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.
2323

@@ -33,6 +33,11 @@ Export metadata from SharePoint in three steps:
3333

3434
### Provision the destination containers and the queue
3535

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+
3641
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.
3742

3843
### Use `CreateSPAsyncReadJob` method to start the export
@@ -47,19 +52,24 @@ Check [AMR API Reference](amr-api-reference.md) for details.
4752

4853
### Checking status
4954

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+
5060
Check Azure Queue supplied for export status. Monitor events as listed in [Events](migration-events.md) for details.
5161

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.
5363

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.
5565

5666
## Best practice
5767

5868
AMR API is powerful. Ensure good performance to achieve the scale for large migration projects.
5969

6070
### Export security and permissions on top level if possible
6171

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.
6373

6474
### Metadata export on a single item
6575

@@ -90,9 +100,9 @@ AMR API processes jobs through a queue mechanism with preconfigured workload man
90100

91101
### Lab-tested performance baseline
92102

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.
94104

95-
There are multiple factors that affect the real-life performance. These factors include:
105+
Multiple factors affect real-life performance. These factors include:
96106

97107
- The number of items that are being exported
98108
- The way AMR API is implemented
@@ -108,6 +118,6 @@ To ensure good user experiences for all Microsoft 365 customers, SharePoint uses
108118

109119
### Tenant-to-Tenant migrations
110120

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.
112122

113123
Microsoft provides no performance guarantee in this scenario. Use Graph or CSOM as needed.

docs/apis/migration-api-overview.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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."
44
ms.date: 07/16/2025
55
ms.author: ranren
66
author: underreview
@@ -15,7 +15,7 @@ ms.collection:
1515
---
1616
# SharePoint Migration API Introduction
1717

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.
1919

2020
Use Migration API to migrate content from file shares, SharePoint Server, and other cloud-based services.
2121

@@ -27,7 +27,7 @@ We applied quota on *Share with Me* items per user. Check [ShareWithMe event quo
2727

2828
### November 2024
2929

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.
3131

3232
### July 2024
3333

@@ -48,7 +48,8 @@ Start a migration job with three steps. Check the guidance in each of the steps
4848
### Provision the destination containers and the queue
4949

5050
> [!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+
>
5253
> 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.
5354
5455
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
8687

8788
Don't use user mode in your migration solution. Running migration in user mode triggers increased throttling, resulting in poor performance.
8889

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).
9091

9192
### Microsoft Entra ID Permissions
9293

@@ -95,17 +96,17 @@ Permissions and consent in the Azure Active Directory v1.0 endpoint](/azure/acti
9596

9697
For SharePoint and OneDrive migration scenarios, follow the Microsoft Entra ID permission specification.
9798

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.
99100

100101
For service-based migration tools that run without a signed-in user present, such as applications that run as background services, use Application permission.
101102

102103
### App IDs
103104

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.
105106

106107
### Keep destination SharePoint Site unactivated
107108

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.
109110

110111
## Performance
111112

0 commit comments

Comments
 (0)