ConvertTo-SPOMigrationTargetedPackage
Use this cmdlet to convert your XML files into a new migration package.
Syntax
DocumentLibraryImport
ConvertTo-SPOMigrationTargetedPackage
[-SourceFilesPath] <String>
[-SourcePackagePath] <String>
[[-OutputPackagePath] <String>]
[-TargetWebUrl] <String>
-TargetDocumentLibraryPath <String>
-Credentials <CredentialCmdletPipeBind>
[-TargetDocumentLibrarySubFolderPath <String>]
[-UserMappingFile <String>]
[-AzureADUserCredentials <CredentialCmdletPipeBind>]
[-NoAzureADLookup]
[-TargetEnvironment <TargetEnvironment>]
[-ParallelImport]
[-PartitionSizeInBytes <Int64>]
[-NoLogFile]
[<CommonParameters>]
ListImport
ConvertTo-SPOMigrationTargetedPackage
[-SourceFilesPath] <String>
[-SourcePackagePath] <String>
[[-OutputPackagePath] <String>]
[-TargetWebUrl] <String>
-TargetListPath <String>
-Credentials <CredentialCmdletPipeBind>
[-UserMappingFile <String>]
[-AzureADUserCredentials <CredentialCmdletPipeBind>]
[-NoAzureADLookup]
[-TargetEnvironment <TargetEnvironment>]
[-ParallelImport]
[-PartitionSizeInBytes <Int64>]
[-NoLogFile]
[<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 $targetDocLib
Parameters
-AzureADUserCredentials
Applicable: SharePoint Online
Receives Microsoft Entra User Credentials
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credentials
Applicable: SharePoint Online
Fill out the Regular Credentials (Get-Credential)
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoAzureADLookup
Applicable: SharePoint Online
Switch parameter that says if the command should or should not look up for Microsoft Entra ID.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoLogFile
Applicable: SharePoint Online
Switch Parameter to determine if you should get or not a log file.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutputPackagePath
Applicable: SharePoint Online
Output package path
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ParallelImport
Applicable: SharePoint Online
Switch parameter to boost file share migration performance.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PartitionSizeInBytes
Applicable: SharePoint Online
Define the partition size in Bytes where it will be located the target package.
Parameter properties
| Type: | System.Int64 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SourceFilesPath
Applicable: SharePoint Online
Defines the temporary Path where are located the XML source files.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SourcePackagePath
Applicable: SharePoint Online
Defines the source package path ___location.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetDocumentLibraryPath
Applicable: SharePoint Online
Defines the target document library path.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DocumentLibraryImport
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetDocumentLibrarySubFolderPath
Applicable: SharePoint Online
Defines the target document library subfolder path.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DocumentLibraryImport
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetEnvironment
Applicable: SharePoint Online
Defines the Target environment: Production, ProductionChina, None or OnPremises.
Parameter properties
| Type: | Microsoft.Online.SharePoint.Migration.TargetEnvironment |
| Default value: | None |
| Accepted values: | Production, ProductionChina, None, OnPremises |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetListPath
Applicable: SharePoint Online
Defines the Target list path
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ListImport
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetWebUrl
Applicable: SharePoint Online
Defines the Target Web URL of the package.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserMappingFile
Applicable: SharePoint Online
Defines the file mapping of the user.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.