Site.GetMigrationJobStatus method
This method queries the queue for the status of the specified migration job. It is an optional check that can be called after the CreateMigrationJob method and uses the id returned by that call. Once the migration job has completed, it will no longer show up in the queue and you should check the notification queue and/or log output for detailed status.
Namespace: Microsoft.SharePoint.Client
Assembly: Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)
Syntax
'Declaration
Public Function GetMigrationJobStatus ( _
id As Guid _
) As ClientResult(Of MigrationJobState)
'Usage
Dim instance As Site
Dim id As Guid
Dim returnValue As ClientResult(Of MigrationJobState)
returnValue = instance.GetMigrationJobStatus(id)
public ClientResult<MigrationJobState> GetMigrationJobStatus(
Guid id
)
Parameters
id
Type: System.GuidThe unique identifier of the migration job returned from the CreateMigrationJob method.
Return value
Type: Microsoft.SharePoint.Client.ClientResult<MigrationJobState>
The migration job status is returned using a MigrationJobState object if the job is found in the queue. If the job is unsuccessful, a value of none (0) is returned.
Examples
SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId);