Get-SPOMigrationJobProgress

Reference

Module:: Microsoft.Online.SharePoint.PowerShell

Applies to:: SharePoint Online

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

Get-SPOMigrationJobProgress
   -AzureQueueUri <String>
   -Credentials <CredentialCmdletPipeBind>
   [-DontWaitForEndJob]
   [-EncryptionParameters <EncryptionParameters>]
   [-JobIds <Guid[]>]
   [-NoLogFile]
   [-TargetWebUrl <String>]
   [<CommonParameters>]

Get-SPOMigrationJobProgress
   -Credentials <CredentialCmdletPipeBind>
   [-DontWaitForEndJob]
   [-EncryptionParameters <EncryptionParameters>]
   [-JobIds <Guid[]>]
   -MigrationPackageAzureLocations <MigrationPackageAzureLocations>
   [-NoLogFile]
   [-TargetWebUrl <String>]
   [<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

An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-Credentials

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.

Type:	CredentialCmdletPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-DontWaitForEndJob

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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-EncryptionParameters

An EncryptionParameters object. See New-SPOMigrationEncryptionParameters https://learn.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters for more information.

Type:	EncryptionParameters
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-JobIds

Id of a previously created migration job that exists on the target site collection.

Type:	Guid[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-MigrationPackageAzureLocations

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

Type:	MigrationPackageAzureLocations
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-NoLogFile

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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-TargetWebUrl

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

Inputs

None

Outputs

System.Object

Share via