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: docs/apis/migration-api-overview.md
+36-3Lines changed: 36 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: "SharePoint Online Import Migration API"
3
3
description: "This article provides in depth information on how to use the SPO Migration API."
4
-
ms.date: 06/28/2022
4
+
ms.date: 12/05/2022
5
5
ms.author: jhendr
6
6
author: JoanneHendrickson
7
7
manager: serdars
@@ -17,7 +17,7 @@ The following API description is based upon use of the SharePoint Client Side Ob
17
17
18
18
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`.
19
19
20
-
> [!Important]
20
+
> [!IMPORTANT]
21
21
> 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).
22
22
>
23
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 requirement.
@@ -57,7 +57,8 @@ The required permissions are as follows in the Azure Storage API:
**Note:** The change to enforce Read and List permissions on the SAS token is coming in a future build. Until then it will not be enforced. However, it is a best practice to use these values.
60
+
> [!NOTE]
61
+
> The change to enforce Read and List permissions on the SAS token is coming in a future build. Until then it will not be enforced. However, it is a best practice to use these values.
61
62
62
63
All files in the container must have at least a single snapshot applied to them to ensure that no file modification is made by the customer during the import. Any file that does not have a snapshot will be skipped during import and have an error thrown, although the job will attempt to continue the import. The import pipeline will use the latest snapshot of the file available at the time of import. The following is an example of the code that might be used to create a snapshot on a file after it is uploaded to Azure Blob Storage:
63
64
@@ -311,6 +312,38 @@ The **ExportSettings.XML** file is expected to be at the root of the Azure Blob
311
312
312
313
The main requirement is that the ExportSettings `SiteUrl` value must be populated with a URL consistent with the source URL used for the rest of the import package. In the case of file shares as a source, the URL would be pre-specified to be the source URL in the rest of the package, whereas a package generated through an export operation at a source site would be its original source site collection URL.
313
314
315
+
#### SourceType required
316
+
317
+
Beginning January 1, 2023, the SourceType field will be mandatory when calling the Migration API. Starting October 1st, 2022, a warning message will be sent if the field is missing.
318
+
319
+
Accepted SourceType values:
320
+
321
+
- AmazonS3
322
+
- AzureStorage
323
+
- Box
324
+
- Dropbox
325
+
- Egnyte
326
+
- FileShare
327
+
- GoogleCloudStorage
328
+
- GoogleDrive
329
+
- MicrosoftStream
330
+
- OneDrive
331
+
- SharePointOnline
332
+
- SharePointOnPremServer
333
+
- Other
334
+
335
+
When declaring to **Other**, include *DetailedSource* to provide us the detailed information.
336
+
337
+
**Example**:
338
+
339
+
```powershell
340
+
<ExportSettings xmlns="urn:deployment-exportsettings-schema" SiteUrl="https://some site url" FileLocation="some paths" IncludeSecurity="All" SourceType="Other" DetailedSource="My special source type not in the list">
341
+
<ExportObjects>
342
+
<DeploymentObject Id="GUID for list" Type="List" ParentId="GUID for web" />
343
+
</ExportObjects>
344
+
</ExportSettings>
345
+
```
346
+
314
347
### LookupListMap.XML
315
348
316
349
The **LookupListMap.XML** file, if included, is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s azureContainerManifestUri parameter. This optional file is validated using the constrained **DeploymentLookupListMap.XSD**, which has no change from current published [full 2013 package schema](../schema/content-migration-schemas.md).
0 commit comments