| external help file | Microsoft.Online.SharePoint.PowerShell.dll-Help.xml |
|---|---|
| Module Name | Microsoft.Online.SharePoint.PowerShell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/convertto-spomigrationtargetedpackage |
| applicable | SharePoint Online |
| title | ConvertTo-SPOMigrationTargetedPackage |
| schema | 2.0.0 |
| author | samkabue |
| ms.author | speedta |
| ms.reviewer |
Use this cmdlet to convert your XML files into a new migration package.
ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] <String> [-SourcePackagePath] <String>
[[-OutputPackagePath] <String>] [-TargetWebUrl] <String> -TargetDocumentLibraryPath <String>
[-TargetDocumentLibrarySubFolderPath <String>] [-UserMappingFile <String>]
-Credentials <CredentialCmdletPipeBind> [-AzureADUserCredentials <CredentialCmdletPipeBind>]
[-NoAzureADLookup] [-TargetEnvironment <TargetEnvironment>] [-ParallelImport] [-PartitionSizeInBytes <Int64>]
[-NoLogFile] [<CommonParameters>]
ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] <String> [-SourcePackagePath] <String>
[[-OutputPackagePath] <String>] [-TargetWebUrl] <String> -TargetListPath <String> [-UserMappingFile <String>]
-Credentials <CredentialCmdletPipeBind> [-AzureADUserCredentials <CredentialCmdletPipeBind>]
[-NoAzureADLookup] [-TargetEnvironment <TargetEnvironment>] [-ParallelImport] [-PartitionSizeInBytes <Int64>]
[-NoLogFile] [<CommonParameters>]
Use this cmdlet to create a migration package from one Library to Another Library in form of a package. It converts the XML files and saves them as a new set of targeted migration package metadata files to the target directory.
This example shows how to convert a package to a targeted one by looking up data in the target site collection. It uses the '-ParallelImport' parameter to boost file share migration performance.
$finalPackages = ConvertTo-SPOMigrationTargetedPackage -ParallelImport -SourceFilesPath $sourceFiles -SourcePackagePath $sourcePackage -OutputPackagePath $targetPackage -Credentials $cred -TargetWebUrl $targetWeb -TargetDocumentLibraryPath $targetDocLibApplicable: SharePoint Online
Receives Microsoft Entra User Credentials
Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Fill out the Regular Credentials (Get-Credential)
Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Switch parameter that says if the command should or should not look up for Microsoft Entra ID.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Switch Parameter to determine if you should get or not a log file.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Output package path
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Switch parameter to boost file share migration performance.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Define the partition size in Bytes where it will be located the target package.
Type: System.Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the temporary Path where are located the XML source files.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the source package path location.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the target document library path.
Type: System.String
Parameter Sets: DocumentLibraryImport
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the target document library subfolder path.
Type: System.String
Parameter Sets: DocumentLibraryImport
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the Target environment: Production, ProductionChina, None or OnPremises.
Type: Microsoft.Online.SharePoint.Migration.TargetEnvironment
Parameter Sets: (All)
Aliases:
Accepted values: Production, ProductionChina, None, OnPremises
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the Target list path
Type: System.String
Parameter Sets: ListImport
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the Target Web URL of the package.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Defines the file mapping of the user.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.