Edit

Get-SPOUserAndContentMoveState

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

This cmdlet allows SharePoint administrators to check the status of a user or site move across geo locations.

Syntax

Get-SPOUserAndContentMoveState
   [-Limit <UInt32>]
   [-MoveDirection <Direction>]
   [-MoveEndTime <DateTime>]
   [-MoveStartTime <DateTime>]
   [-MoveState <State>]
   [<CommonParameters>]
Get-SPOUserAndContentMoveState
   -OdbMoveId <Guid>
   [<CommonParameters>]
Get-SPOUserAndContentMoveState
   -UserPrincipalName <String>
   [<CommonParameters>]

Description

This command gets the information and the status of a move request of a user between sites in a SharePoint Online Multi Geo tenant.

The following are the available move states:

Status Description
ReadyToTrigger The move is ready to be initiated by an administrator.
NotStarted The move has not started.
InProgress The move is in progress in one of the following states: Validation, Backup, Restore, Cleanup.
Success The move has completed successfully.
Failed The move failed.

Examples

Example 1

Get-SPOUserAndContentMoveState -OdbMoveId b298219e-3440-10b8-8931-46e805e2b85b

Obtain the move state by OneDrive Move Job ID

Example 2

Get-SPOUserAndContentMoveState -MoveState NotStarted

Getting which moves are being done in a particular state

Example 3

Get-SPOUserAndContentMoveState -MoveDirection All

Gives you the output for users moving in and out from the geo location you are logged into

Example 4

Get-SPOUserAndContentMoveState -MoveDirection In

Gives you the output for users moving into the geo location that you are logged into

Example 5

Get-SPOUserAndContentMoveState -MoveDirection Out

Gives you the output for users moving out from the geo location that you are logged into

Example 6

Get-SPOUserAndContentMoveState -UserPrincipalName jezz@contoso.com

Obtains the status of the move for jezz@contoso.com

Parameters

-Limit

Get the limit of user on a single call of the parameter

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

-MoveDirection

Allows you to define the direction of the user move in relation to your current SharePoint location

Type:Direction
Accepted values:All, MoveIn, MoveOut
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-MoveEndTime

Allows you to obtain the moves that are scheduled to end by a particular time, as defined in UTC

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

-MoveStartTime

Allows you to obtain the moves that are scheduled to begin at a particular time, as defined in UTC

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

-MoveState

Move State current status.

Type:State
Accepted values:All, NotStarted, Scheduled, InProgress, Stopped, Success, Failed
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-OdbMoveId

OneDrive GUID MoveID that you get when you start a job.

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

-UserPrincipalName

User Principal name is the unique property on Microsoft Entra ID for each user.

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