SPO Migration
This component allows you to migrate to SharePoint Online (using migration packages) into existing sites. It uses the SharePoint Migration API. It does this by communicating with Azure Storage and SharePoint Online to perform the migration. Packages and binaries are uploaded to Azure storage and then the migration is triggered from SharePoint Online.
In migration mode the component creates two containers (folders) in Azure Storage blob storage, these can be found under Data storage -> Containers, named in Azure Storage as manifest container and source container. When the containers are created the following is being processed in order:
-
manifest container: the manifest files from the package will be uploaded to this container as blobs. Documentation on the manifest files can be found here
-
source container: the files (that will be migrated to SharePoint Online) on the local file system or MongoDB will be uploaded to this container as blobs.
Above actions will be performed using the Azure Blob Storage.
-
When all blobs are uploaded into the manifest and source container, the content will be imported to SharePoint Online from Azure Storage Containers using the SharePoint Migration API.
The component also supports exporting from SharePoint Online using the SharePoint Asynchronous Metadata Read (AMR) API and has two additional modes:
- Export: starts an export job that writes SharePoint metadata as an export package (similar to the migration package used in migrate mode) to the designated Azure Storage container specified in the component configuration.
- Retrieve export: retrieves the resulting export package from Azure Storage and saves it to the destination specified by
packagePath, on the local file system or cloud storage. See how it works:
SPO Migration Explainer
Detailed process description
Configuration
Inputs | Outputs
Config mode set to Migrate
In this example the configuration setting packagePath is set to {{ packagePath }} and the SharePoint web URL is set to {{ webUrl }}. The manifest (package) files are located in C:/Training and the target site is https://company.sharepoint.com/sites/demo-site.
Example:
{
"packagePath": "C:/Training",
"webUrl": "https://company.sharepoint.com/sites/demo-site"
}
Config mode set to Retrieve logs
In this example the configuration setting Azure manifest container URI is set to {{ azureContainerManifestUri }} and Migration job ID to {{ migrationJobId }}. The logs from the migration example above are retrieved. When using provisioned containers or doing an encrypted migration using storage account, make sure to fill the optional Encryption key setting. This value is retrieved from the result of the migration. In the example it is set to {{encryptionKey}}.
Example: (using storage account):
{
"azureContainerManifestUri": "https://test.blob.core.windows.net/0-23233-232232",
"migrationJobId": "22-dfs2fsd-wew34dfs-wds"
}
Example: (using storage account if migrated with setting Encrypt storage account migration data):
{
"azureContainerManifestUri": "https://test.blob.core.windows.net/0-23233-232232",
"migrationJobId": "22-dfs2fsd-wew34dfs-wds",
"encryptionKey": "key"
}
Example: (using provisioned containers enabled):
{
"azureContainerManifestUri": "https://test.blob.core.windows.net/0-23233-232232",
"migrationJobId": "22-dfs2fsd-wew34dfs-wds",
"encryptionKey": "key"
}
Config mode set to Delete containers
In this example the configuration setting Container names is set to {{ $ containerNames }}. The created manifest and source container in Azure Storage with the migration from the example above will be deleted.
Provisioned containers are deleted automatically by SharePoint.
Example:
{
"containerNames": ["manifest-sd233-2flg3-sss21", "source-saf3d-dw3fg-sdf32"]
}
Config mode set to Export
In this example the configuration setting SharePoint web URL is set to {{ webUrl }} and the Source path is set to {{ sourcePath }}. The target for export is https://company.sharepoint.com/sites/demo-site/documentLibrary.
Example:
{
"sourcePath": "documentLibrary",
"webUrl": "https://company.sharepoint.com/sites/demo-site"
}
Config mode set to Retrieve export
In this example the configuration setting Azure manifest container URI is set to {{ azureContainerManifestUri }}, Migration job ID to {{ migrationJobId }}, packagePath is set to {{ packagePath }} and the SharePoint web URL is set to {{ webUrl }}. This example also includes the optional Encryption key which is set to {{ encryptionKey }}.
Example:
{
"packagePath": "C:/xill4/exportPackage",
"webUrl": "https://company.sharepoint.com/sites/demo-site",
"azureContainerManifestUri": "https://test.blob.core.windows.net/0-23233-232232",
"migrationJobId": "22-dfs2fsd-wew34dfs-wds",
"encryptionKey": "key"
}