Skip to content

Commit 60d4367

Browse files
Merge pull request SharePoint#7965 from JoanneHendrickson/patch-61
Update migration-api-overview.md
2 parents 93f2d93 + 71eda22 commit 60d4367

File tree

1 file changed

+52
-7
lines changed

1 file changed

+52
-7
lines changed

docs/apis/migration-api-overview.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "SharePoint Online Import Migration API"
33
ms.prod: sharepoint
4-
ms.date: 08/19/2021
4+
ms.date: 05/19/2022
55
ms.author: jhendr
66
author: JoanneHendrickson
77
manager: serdars
@@ -17,12 +17,12 @@ The following API description is based upon use of the SharePoint Client Side Ob
1717

1818
You can find latest version of the SharePoint Online Client Side Object Model (CSOM) package from the [NuGet gallery](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM/). Use the ID `Microsoft.SharePointOnline.CSOM`.
1919

20-
>[!Important]
20+
> [!Important]
2121
> Files larger than 15 GB must now create the required checksum using [QuickXorHash](/onedrive/developer/code-snippets/quickxorhash). We have provided an example [here](#what-is-stored-in-those-azure-blob-containers).
2222
>
23-
>The QuickXorHash/Checksum has to be computed for the original file **before** encryption (if the file is being encrypted). This is different from the MD5hash requirementt.
23+
> The QuickXorHash/Checksum has to be computed for the original file **before** encryption (if the file is being encrypted). This is different from the MD5hash requirementt.
2424
>
25-
>The previous method of MD5Hash is still required for files smaller than 2 GB; however this requirement will be removed at some point in the future.
25+
> The previous method of MD5Hash is still required for files smaller than 2 GB; however this requirement will be removed at some point in the future.
2626
2727

2828
## Methods
@@ -452,8 +452,8 @@ Even if the API support 15GB files, we recommend package sizes of up to 250 MB O
452452

453453
### File size
454454

455-
>[!Note]
456-
>The Migration API supports individual files over **15 GB**. The maximum size is current to that set by SharePoint Online.
455+
> [!Note]
456+
> The Migration API supports individual files over **15 GB**. The maximum size is current to that set by SharePoint Online.
457457
458458
### Only un-compressed packages are supported
459459

@@ -492,6 +492,51 @@ The import pipeline is using Azure Blob Storage security model as is. This means
492492
### Events and event handlers
493493

494494
The import pipeline allows event handlers to be referenced on list items but doesn’t allow defining event handlers at the list level at this time. The import pipeline does not fire events as items are imported, so existing event handlers will not fire due to the import event.
495+
### Entering user identifiers in UserGroup.XML
496+
497+
Follow these guidelines when generating the **UserGroup.XML** in the submitted package:
498+
499+
- A person can be identified only once in a single package
500+
- The 'login' attribute of the user identifier requires a UPN. **Do not** enter a non-UPN email address.
501+
502+
503+
> [!Important]
504+
> As of March 2, 2022, the Migration API now validates and enforces a maximum of one identifier per user in a single package.
505+
>
506+
> While using a non-UPN email won't result in a failed job, it may bring unexpected results in SharePoint Online.
507+
508+
**Examples**
509+
510+
The following examples show the correct and incorrect ways of entering the user identifier in UserGroup.XML.
511+
512+
In this case, the user has the following identifiers:
513+
514+
515+
- **Email**: [email protected].
516+
517+
518+
**Correct**
519+
520+
- In this example, the user is entered only once, using a UPN email address.
521+
522+
```xml
523+
<User Id="1" Login="i:0#.f|membership|[email protected]" …/>
524+
```
525+
526+
**Incorrect**
527+
528+
- **Example 1:** This example uses a non-UPN email address and incorrectly includes more than identifier for a single user.
529+
530+
```xml
531+
<User Id="1" Login="i:0#.f|membership|[email protected]" …/>
532+
<User Id="2" Login="i:0#.f|membership|[email protected]" …/>
533+
```
534+
535+
- **Example 2:** This example incorrectly uses a non-UPN email address.
536+
537+
```xml
538+
<User Id="2" Login="i:0#.f|membership|[email protected]" …/>
539+
```
495540

496541
### Resolving Users
497542

@@ -500,7 +545,7 @@ If the Migration API was unable to resolve a user using the login provided in th
500545
1. This user will be replaced by “System Account” in the associated metadata within the package ( author, editor etc.).
501546
1. A warning will be reported in the ImportLogs – “Failed to ensure user '[email protected]'”
502547

503-
If the migration API was unable to resolve a user using the login provided in the UserGroup.xml and the System ID is provided (which is the SID for the user in the on-premises AD), then:
548+
If the migration API was unable to resolve a user using the login provided in the UserGroup.xml and the System ID is provided (which is the SID for the user in the on-premises AD), then:
504549

505550
1. A new deleted user with the provided login and SystemId is created and is used in the associated metadata within the package.
506551
1. A warning will be reported in the ImportLogs- “Failed to retrieve user '[email protected]' attributes from the SiteUsers; falling back to passed in values”

0 commit comments

Comments
 (0)