ConvertTo-SPOMigrationTargetedPackage
Use this cmdlet to convert your XML files into a new migration package.
Syntax
ConvertTo-SPOMigrationTargetedPackage
[-SourceFilesPath] <String>
[-SourcePackagePath] <String>
[[-OutputPackagePath] <String>]
[-TargetWebUrl] <String>
[-AzureADUserCredentials <CredentialCmdletPipeBind>]
-Credentials <CredentialCmdletPipeBind>
[-NoAzureADLookup]
[-NoLogFile]
[-ParallelImport]
[-PartitionSizeInBytes <Int64>]
-TargetDocumentLibraryPath <String>
[-TargetDocumentLibrarySubFolderPath <String>]
[-TargetEnvironment <TargetEnvironment>]
[-UserMappingFile <String>]
[<CommonParameters>] ConvertTo-SPOMigrationTargetedPackage
[-SourceFilesPath] <String>
[-SourcePackagePath] <String>
[[-OutputPackagePath] <String>]
[-TargetWebUrl] <String>
[-AzureADUserCredentials <CredentialCmdletPipeBind>]
-Credentials <CredentialCmdletPipeBind>
[-NoAzureADLookup]
[-NoLogFile]
[-ParallelImport]
[-PartitionSizeInBytes <Int64>]
[-TargetEnvironment <TargetEnvironment>]
-TargetListPath <String>
[-UserMappingFile <String>]
[<CommonParameters>] Description
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.
Examples
Example 1
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 $targetDocLibParameters
-AzureADUserCredentials
Receives Microsoft Entra User Credentials
| Type: | CredentialCmdletPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-Credentials
Fill out the Regular Credentials (Get-Credential)
| Type: | CredentialCmdletPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-NoAzureADLookup
Switch parameter that says if the command should or should not look up for Microsoft Entra ID.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-NoLogFile
Switch Parameter to determine if you should get or not a log file.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-OutputPackagePath
Output package path
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-ParallelImport
Switch parameter to boost file share migration performance.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-PartitionSizeInBytes
Define the partition size in Bytes where it will be located the target package.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-SourceFilesPath
Defines the temporary Path where are located the XML source files.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-SourcePackagePath
Defines the source package path location.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-TargetDocumentLibraryPath
Defines the target document library path.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-TargetDocumentLibrarySubFolderPath
Defines the target document library subfolder path.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-TargetEnvironment
Defines the Target environment: Production, ProductionChina, None or OnPremises.
| Type: | TargetEnvironment |
| Accepted values: | Production, ProductionChina, None, OnPremises |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-TargetListPath
Defines the Target list path
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-TargetWebUrl
Defines the Target Web URL of the package.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-UserMappingFile
Defines the file mapping of the user.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |