Add-SPMTTask
Add a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task.
Syntax
Add-SPMTTask
-FileShareSource <String>
-TargetSiteUrl <String>
-TargetList <String>
[-TargetListRelativePath <String>]
Add-SPMTTask
-SharePointSourceCredential <PSCredential>
-SharePointSourceSiteUrl <string>
-TargetSiteUrl <string>
-MigrateAll
Add-SPMTTask
-SharePointSourceSiteUrl <string>
-SharePointSourceCredential <PSCredential>
-SourceList <string>
[-SourceListRelativePath <string>]
-TargetSiteUrl <string>
-TargetList <string>
[-TargetListRelativePath <string>]
Add-SPMTTask
[-SharePointSourceCredential <PSCredential>]
-JsonDefinition <String>
[<CommonParameters>]
Examples
EXAMPLE 1
#Define SharePoint 2013 data source#
$Global:SourceSiteUrl = "https://YourOnPremSite/"
$Global:OnPremUserName = "Yourcomputer\administrator"
$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force
$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword
$Global:SourceListName = "SourceListName"
#Define SPO target#
$Global:SPOUrl = "https://contoso.sharepoint.com"
$Global:UserName = "admin@contoso.onmicrosoft.com"
$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force
$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord
$Global:TargetListName = "TargetListName"
#Define File Share data source#
$Global:FileshareSource = "YourFileShareDataSource"
#Import SPMT Migration Module#
Import-Module Microsoft.SharePoint.MigrationTool.PowerShell
#Register the SPMT session with SPO credentials#
Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force
#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.#
Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl -TargetSiteUrl $Global:SPOUrl -MigrateAll
Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName
This example adds one File Share migration task and one SharePoint 2013 migration task to the registered migration session.
EXAMPLE 2
# Code snippets for bulk migration by loading the sample CSV with the name of spmt.csv
$csvItems = import-csv "C:\spmt.csv" -Header c1,c2,c3,c4,c5,c6
ForEach ($item in $csvItems)
{
Write-Host $item.c1
Add-SPMTTask -FileShareSource $item.c1 -TargetSiteUrl $item.c4 -TargetList $item.c5 -TargetListRelativePath $item.c6
}
# Two migration tasks are defined in the file spmt.csv
D:\MigrationTest\Files\Average_1M\c,,,https://SPOSite.sharepoint.com,Documents,Test
C:\work\Powershell\negative,,,https://SPOSite.sharepoint.com/,Documents,DocLibrary_SubfolderName
# Code snippets for bulk migration by loading one JSON file:
$jsonItems = Get-Content -Raw -Path "C:\spmt.json" | ConvertFrom-Json
ForEach ($taskItem in $jsonItems.Tasks)
{
$jsonString = ConvertTo-Json $taskItem -Depth 100
Add-SPMTTask -JsonDefinition $jsonString -SharePointSourceCredential $onpremCredential
}
# Three migration tasks are defined in the file spmt.json.
{
"Tasks":[
{
"SourcePath":"https://On-prem/sites/test",
"TargetPath":"https://YourSPO.sharepoint.com",
"Items":{
"Lists":[
{
"SourceList":"list-01",
"TargetList":"list-01"
}
],
"SubSites":[
]
}
},
{
"SourcePath":"https://On-prem/sites/test",
"TargetPath":"https://YourSPO.sharepoint.com",
"Items":{
"Lists":[
{
"SourceList":"list-02",
"TargetList":"list-02"
}
],
"SubSites":[
]
}
},
{
"SourcePath":"https://On-prem/sites/test",
"TargetPath":"https://YourSPO.sharepoint.com",
"Items":{
"Lists":[
{
"SourceList":"doclib-01",
"TargetList":"doclib-01"
}
],
"SubSites":[
]
}
}
]
}
This example adds a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task.
EXAMPLE 3
{
"SourcePath":"\\LocalOrFileShareDataSource",
"TargetPath":"https://YourTargetSite",
"TargetList":"Documents",
"TargetListRelativePath":"subfolder"
}
Json sample for SharePoint migration(lists only):
{
"SourcePath":"https://YourOnPremSite",
"TargetPath":"https://YourTargetSite",
"Items":{
"Lists":[
{
"SourceList":"sourceListName",
"TargetList":"targetListName"
}
]
}
}
Json sample for SharePoint migration(lists and subsites):
{
"SourcePath":"https://YourOnPremSite",
"TargetPath":"https://YourTargetSite",
"Items":{
"Lists":[
{
"SourceList":"listVersion2",
"TargetList":"ListVersion2"
},
{
"SourceList":"listVersion3",
"TargetList":"ListVersion3"
}
],
"SubSites":[
{
"SourceSubSitePath":"subSite",
"TargetSubSitePath":"targetSubSite",
"Lists":[
{
"SourceList":"testSubListB",
"TargetList":"targetSubList"
}
]
}
]
}
}
Json sample for SharePoint migration(whole site):
{
"SourcePath":"https://YourOnPremSite/subsite2",
"TargetPath":"https://YourTargetSite/targetSubSite2"
}
Json sample with task level setting:
{
"Tasks": [
{
"SourcePath": "https://YourOnPremServerSiteURL",
"TargetPath": "https://YourTargetSiteURL",
"Items": {
"Lists": [
{
"SourceList": "SourceListName",
"TargetList": "TargetListName"
}
],
"SubSites": []
},
"Settings": {
"MigrateFileVersionHistory": true,
"KeepFileVersions": 100,
"MigrateHiddenItems": false,
"MigrateItemsCreatedAfter": "yyyy-MM-dd",
"MigrateItemsModifiedAfter": "yyyy-MM-dd",
"SkipFilesWithExtensions": "txt:mp3:OtherFileExtentionsYouwantSkip",
"EnableAzureDirectoryLookup": false,
"PreservePermission": true,
"UseCustomAzureStorage": false,
"CustomAzureStorageAccount": null,
"CustomAzureAccessKey": null,
"CustomAzureDeletionAfterMig": false,
"UserMappingCSVFile": null,
"SkipListWithAudienceEnabled": true,
"EnableIncremental": false,
"MigrateOneNoteNotebook": true,
"MigrateAllWebStructures": false,
"FilterOutPathSpecialCharacters": false
}
}
]
}
Note: Datetime format is "yyyy-MM-dd"
This is a Json sample for File Share migration.
Parameters
-FileShareSource
This parameter is mandatory for File Share migration. Please specify the source folder path. For example: C:\SourceFiles.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonDefinition
Define one File share task or SharePoint task in JSON format.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MigrateAll
This is a switch parameter. If set to True, all lists will be migrated. If set to False, the customer will migrate selected lists.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SharePointSourceCredential
Use this parameter to define SharePoint 2013 sign-in credentials.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SharePointSourceSiteUrl
Use this parameter to define SharePoint data source site URL.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceList
This parameter is mandatory and is to define source document library name or list name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceListRelativePath
This parameter is optional and is to define data source relative path.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetList
This parameter is mandatory and is to define target library name or list name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetListRelativePath
This parameter is optional and is to define target relative path.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetSiteUrl
This parameter is mandatory for both File Share and SharePoint migration and is to define the target site URL.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour