Automating SharePoint Online Migration Using Sharegate

Please note that ‘CheckUrl’ is the custom function that is integrated in this Migration Script, this function is to check whether the destination site is active and has proper permissions to the account that is running the migration.

• Merge: to merge the source site into the destination site
• NoCustomizedListForms: since SharePoint online comes with modern UI by default, using this option will have the lists and libraries that are migrated from the source to have modern look and feel.
• CopySettings: this is used to tell the migration to be done in an incremental model
• ErrorAction: this parameter is used here to stop the migration and log the error when some unexpected error occurs.
• Update: Updated the below 'Complete Script' to use the existing connection.

Complete Script

# Load the sites from CSV
# check for incremental - Completed
# check for migration speed control - Need to check with SG team 
# check for monitoring the running jobs, if gets throttled, is there option to pause 
#Script Updated to use existing connection
# The script is based on moving On-Prem SP2013 to SharePoint online
function CheckUrl($urlparam) {
  <#
    .Description
    This function checks the destination URL after loaded from CSV
  #>
    try {
        Write-Host "verifying the url $urlparam" -ForegroundColor Yellow
        $CheckConnection = Invoke-WebRequest -Uri $urlparam
        if($CheckConnection.StatusCode -eq 200) {
        Write-Host "Connection Verified" -ForegroundColor Green
        $status="Success"
    }
}
catch [System.Net.WebException] {
    $ExceptionMessage = $Error[0].Exception
    if ($ExceptionMessage -match "403") {
    Write-Host "URL exists, but you are not authorized" -ForegroundColor Yellow
    Write-LogWarning -Message "URL $urlparam exists, but you are not authorized" -TimeStamp -LogPath $ErrorLogFile
    }
    elseif ($ExceptionMessage -match "503"){
    Write-Host "Error: Server Busy" -ForegroundColor Red
    Write-LogWarning -Message "URL $urlparam exists, but server is busy" -TimeStamp -LogPath $ErrorLogFile
    }
    elseif ($ExceptionMessage -match "404"){
    Write-Host "Error: URL doesn't exists" -ForegroundColor Red
    Write-LogError -Message "URL $urlparam doesn't exists" -TimeStamp -LogPath $ErrorLogFile
    
    }
    else{
    Write-Host "Error: There is an unknown error" -ForegroundColor Red
    Write-LogError -Message "URL $urlparam unknown error" -TimeStamp -LogPath $ErrorLogFile
    }
    $status="Error Occured"
}
return $status
}
 

Import-Module PSLogging
$CurrentDate = Get-Date
$DateFormat = $CurrentDate.ToString('MM-dd-yyyy_hh-mm-ss')
#Update the path to the operation logs. 
$LogPath = "C:\Users\tuser10\Temp\OpsLogs"
#update the path to error logs
$ErrorLogFile= "C:\Users\tuser10\Temp\ErrorLogs\MigraionError_" + $DateFormat + ".txt"
$LogName = "MigraionLogs_" + $DateFormat + ".log"
$LogFullPath = $LogPath + "\" + $LogName
#Change the path to CSV file where the source and destination sites are updated according to template. 
$SitesInfo = Import-Csv -Path "C:\Users\tuser10\Desktop\VinayWorkingDocs\Migration\ToBeMigrated3.csv"

Start-Log -LogPath $LogPath -LogName $LogName -ScriptVersion "1.0" | Out-Null  
# setting to incremental update. 
$copySettings = New-CopySettings -OnContentItemExists IncrementalUpdate
#use any of existing site where the account has Site Collection Admin rights and store in variable to use it for btach migrations
$m365Connection = Connect-Site -Url "https://contoso.sharepoint.com/teams/qavinay" -Browser -DisableSSO

foreach($record in $SitesInfo){
    
    $SiteCheck = CheckUrl($record.DestinationSite)
    if($SiteCheck -contains "Success") {
        try {
            $srcSite = Connect-Site -Url $record.SourceSite
            # for destination to connect use cached credentials from the previous connection $m365Connection.
            $dstSite = Connect-Site -Url $record.DestinationSite -UseCredentialsFrom $m365Connection
            Write-Host "Migration started from $srcSite to $dstSite" -ForegroundColor Yellow
            Write-LogInfo -Message "**************************************************************************************************************" -LogPath $LogFullPath
            Write-LogInfo -Message "Source Site: $srcSite" -LogPath $LogFullPath
            Write-LogInfo -Message "Destination Site: $dstSite" -LogPath $LogFullPath
            $MigrationResult = Copy-Site -Site $srcSite -DestinationSite $dstSite -Merge -NoCustomizedListForms  -CopySettings $copySettings -ErrorAction Stop 
            Write-Host $MigrationResult.Errors
            Write-Host $MigrationResult.Result

    
            if($MigrationResult.Errors -ne $null){
                Write-Host "The migration completed with errors" -ForegroundColor Yellow
                
                Write-LogInfo -Message $MigrationResult.Result -TimeStamp -LogPath $LogFullPath        
                Write-LogInfo -Message "**************************************************************************************************************`r`n" -LogPath $LogFullPath
            }

        }
        catch {
            $ErrorMessage = $_
            Write-Host "An Exception occured...$ErrorMessage"
            Write-LogError -Message $ErrorMessage -TimeStamp -LogPath $ErrorLogFile
        }
    }
    else {
    Write-Host "Error Occured... $SiteCheck" -ForegroundColor Red
    
    }
}
    

Conclusion

Thus, in this article, we have seen how to perform the migration for multiple sites in one shot using Sharegate Desktop Shell.

References

• Migration Tools For Office 365 Cloud
• Lessons Learnt Using Sharegate Migration Tool In The Trials Made
• https://migration-tool.sharegate.com/hc/en-us/articles/115000641488
• https://migration-tool.sharegate.com/hc/en-us/articles/115000597467-Copy-Site
• https://docs.microsoft.com/en-us/sharepoint/planning-hub-sites
• https://github.com/vayinapurapu/SharePointOnlineMigration/blob/main/SharegateMigration.ps1