Edit

Share via

Get-MigrationUser

Module:
Exchange PowerShell

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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 Exchange cmdlet syntax.

Syntax

MailboxGuid 

Get-MigrationUser
    -MailboxGuid <Guid>
    [-DomainController <Fqdn>]
    [-IncludeAssociatedUsers]
    [-ResultSize <Unlimited>]
    [-Partition <MailboxIdParameter>]
    [<CommonParameters>]

StatusAndBatchId 

Get-MigrationUser
    [-BatchId <MigrationBatchIdParameter>]
    [-Status <MigrationUserStatus>]
    [-StatusSummary <MigrationUserStatusSummary>]
    [-DomainController <Fqdn>]
    [-IncludeAssociatedUsers]
    [-ResultSize <Unlimited>]
    [-Partition <MailboxIdParameter>]
    [<CommonParameters>]

Identity 

Get-MigrationUser
    [[-Identity] <MigrationUserIdParameter>]
    [-DomainController <Fqdn>]
    [-IncludeAssociatedUsers]
    [-ResultSize <Unlimited>]
    [-Partition <MailboxIdParameter>]
    [<CommonParameters>]

EmailAddress 

Get-MigrationUser
    -EmailAddress <SmtpAddress>
    [-DomainController <Fqdn>]
    [-IncludeAssociatedUsers]
    [-ResultSize <Unlimited>]
    [-Partition <MailboxIdParameter>]
    [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-MigrationUser -Identity TonySmith@contoso.com

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

Example 2

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

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

Example 3

Get-MigrationUser -EmailAddress TonySmith@contoso.com

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

Example 4

Get-MigrationUser -EmailAddress TonySmith@contoso.com | Get-MigrationUserStatistics

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

Parameters

-BatchId

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Parameter properties

Type:MigrationBatchIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

StatusAndBatchId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DomainController

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Parameter properties

Type:Fqdn
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

-EmailAddress

Applicable: Exchange Online

The EmailAddress parameter specifies the particular user that you want to retrieve information about. The EmailAddress parameter is represented as an email address. This parameter is available only in the cloud-based service.

Parameter properties

Type:EmailAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EmailAddress
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Parameter properties

Type:MigrationUserIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-IncludeAssociatedUsers

Applicable: Exchange Online

This parameter is available only in the cloud-based service.

{{ Fill IncludeAssociatedUsers Description }}

Parameter properties

Type: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

-MailboxGuid

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

MailboxGuid
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Partition

Applicable: Exchange Online

This parameter is available only in the cloud-based service.

This parameter is reserved for internal Microsoft use.

Parameter properties

Type:MailboxIdParameter
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

-ResultSize

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Parameter properties

Type:Unlimited
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

-Status

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Parameter properties

Type:MigrationUserStatus
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

StatusAndBatchId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StatusSummary

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Parameter properties

Type:MigrationUserStatusSummary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

StatusAndBatchId
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.

Inputs

Input types

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.

Outputs

Output types

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.