Get-SPOMigrationJobProgress
Note: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see Migrate to SharePoint using PowerShell.
This cmdlet lets you report on SPO migration jobs that are in progress.
Syntax
AzureLocationsInline
Get-SPOMigrationJobProgress
-AzureQueueUri <String>
-Credentials <CredentialCmdletPipeBind>
[-TargetWebUrl <String>]
[-JobIds <Guid[]>]
[-EncryptionParameters <EncryptionParameters>]
[-DontWaitForEndJob]
[-NoLogFile]
[<CommonParameters>]
AzureLocationsImplicit
Get-SPOMigrationJobProgress
-Credentials <CredentialCmdletPipeBind>
-MigrationPackageAzureLocations <MigrationPackageAzureLocations>
[-TargetWebUrl <String>]
[-JobIds <Guid[]>]
[-EncryptionParameters <EncryptionParameters>]
[-DontWaitForEndJob]
[-NoLogFile]
[<CommonParameters>]
Description
This cmdlet lets you report on SPO migration jobs that are in progress.
Examples
EXAMPLE 1
$myQueueUri = <uri to azure report queue>
Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri
This will report on ALL jobs within the report queue.
EXAMPLE 2
$jobIds = @(<jobid1>,<jobId2>....)
Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri -JobIds $jobIds
This will report only jobs defined within the $jobIds collection from the report queue.
EXAMPLE 3
$targetWebUrl = <myTargetWebUrl>
$creds = <my site credentials>
Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWebUrl -Credentials $creds
This will report on any currently queued or in progress jobs and wait for all jobs to complete.
EXAMPLE 4
$targetWebUrl = <myTargetWebUrl>
$creds = <my site credentials>
Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWebUrl -Credentials $creds -DontWaitForJobEnd
This will report on any currently queued or in progress jobs and not wait for all jobs to complete.
Parameters
-AzureQueueUri
Applicable: SharePoint Online
An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AzureLocationsInline
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credentials
Applicable: SharePoint Online
Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session's previous call to Connect-SPOService will be used to connect to the site collection.
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 |
-DontWaitForEndJob
Applicable: SharePoint Online
Tells the cmdlet to not wait for the job to end. It will only process as many messages as are currently in the queue and then terminate. If this flag is set to $false, it will wait for the job to end before terminating.
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 |
-EncryptionParameters
Applicable: SharePoint Online
An EncryptionParameters object. See New-SPOMigrationEncryptionParameters https://learn.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters for more information.
Parameter properties
| Type: | Microsoft.Online.SharePoint.Migration.EncryptionParameters |
| 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 |
-JobIds
Applicable: SharePoint Online
Id of a previously created migration job that exists on the target site collection.
Parameter properties
| Type: | System.Guid[] |
| 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 |
-MigrationPackageAzureLocations
Applicable: SharePoint Online
A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the Set-SPOMigrationPackageAzureSource
Parameter properties
| Type: | Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AzureLocationsImplicit
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoLogFile
Applicable: SharePoint Online
Indicates to not create a log file. The default is to create a new CopyMigrationPackage log file within the directory specified within the SourcePackagePath parameter.
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 |
-TargetWebUrl
Applicable: SharePoint Online
The fully qualified target web URL where the package will be imported into. This must include the same TargetWebURL that was used during ConvertTo-SPOMigrationTargetedPackage.
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.