Export (0) Print
Expand All

Get-MigrationUser

Exchange Online
 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-07-09

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationUser cmdlet to view information about move and migration users.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-MigrationUser [-Identity <MigrationUserIdParameter>] <COMMON PARAMETERS>
Get-MigrationUser -MailboxGuid <Guid> <COMMON PARAMETERS>
Get-MigrationUser [-BatchId <MigrationBatchIdParameter>] [-Status <Queued | Syncing | Failed | Synced | IncrementalFailed | Completing | Completed | CompletionFailed | Corrupted | Provisioning | ProvisionUpdating | CompletionSynced | Validating | IncrementalSyncing | IncrementalSynced | CompletedWithWarnings | Stopped | IncrementalStopped | Starting | Stopping | Removing>] [-StatusSummary <Active | Failed | Synced | Completed | Stopped>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-Partition <MailboxIdParameter>] [-ResultSize <Unlimited>]

This example retrieves status information about the recently migrated user, Tony Smith.

Get-MigrationUser -Identity TonySmith@contoso.com

This example retrieves more detailed information about any ongoing migration for the user with the specified mailbox GUID.

Get-MigrationUser -MailboxGuid b6a6795c-a010-4f67-aaaa-da372d56fcb9 | Get-MigrationUserStatistics

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Mailbox move and migration permissions" section in the Recipients Permissions topic.

 

Parameter Required Type Description

MailboxGuid

Required

System.Guid

The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information.

BatchId

Optional

Microsoft.Exchange.Management.Migration.MigrationBatchIdParameter

The BatchId parameter specifies the name of the migration batch for which you want to return users.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

This parameter is reserved for internal Microsoft use.

Identity

Optional

Microsoft.Exchange.Management.Migration.MigrationUserIdParameter

The Identity parameter specifies the particular user that you want to retrieve information about. The Identity parameter is represented as an email address.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Partition

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter is reserved for internal Microsoft use.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all users that match the query, use unlimited for the value of this parameter. The default value is 1000.

Status

Optional

Microsoft.Exchange.Data.Storage.Management.MigrationUserStatus

The Status parameter returns information about migration users that have the specified status state. Use one of the following values:

  • Completed

  • CompletedWithWarnings

  • Completing

  • CompletionFailed

  • CompletionSynced

  • Corrupted

  • Failed

  • IncrementalFailed

  • IncrementalStopped

  • IncrementalSynced

  • IncrementalSyncing

  • Provisioning

  • ProvisionUpdating

  • Queued

  • Removing

  • Starting

  • Stopped

  • Stopping

  • Synced

  • Syncing

  • Validating

StatusSummary

Optional

Microsoft.Exchange.Data.Storage.Management.MigrationUserStatusSummary

The StatusSummary parameter returns abbreviated information about migration users that have the specified status value. Use one of the following values:

  • Active

  • Completed

  • Failed

  • Stopped

  • Synced

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft