Get-MigrationUser
This cmdlet is available in on-premises Exchange 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 Exchange cmdlet syntax.
Syntax
Get-MigrationUser
-MailboxGuid <Guid>
[-DomainController <Fqdn>]
[-IncludeAssociatedUsers]
[-ResultSize <Unlimited>]
[-Partition <MailboxIdParameter>]
[<CommonParameters>] Get-MigrationUser
[-BatchId <MigrationBatchIdParameter>]
[-Status <MigrationUserStatus>]
[-StatusSummary <MigrationUserStatusSummary>]
[-DomainController <Fqdn>]
[-IncludeAssociatedUsers]
[-ResultSize <Unlimited>]
[-Partition <MailboxIdParameter>]
[<CommonParameters>] Get-MigrationUser
[[-Identity] <MigrationUserIdParameter>]
[-DomainController <Fqdn>]
[-IncludeAssociatedUsers]
[-ResultSize <Unlimited>]
[-Partition <MailboxIdParameter>]
[<CommonParameters>] 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 topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not 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.comThis example retrieves status information about the recently migrated user, Tony Smith.
Example 2
Get-MigrationUser -MailboxGuid b6a6795c-a010-4f67-aaaa-da372d56fcb9 | Get-MigrationUserStatisticsThis example retrieves more detailed information about any ongoing migration for the user with the specified mailbox GUID.
Example 3
Get-MigrationUser -EmailAddress TonySmith@contoso.comThis example retrieves status information about the recently migrated user, Tony Smith.
Example 4
Get-MigrationUser -EmailAddress TonySmith@contoso.com | Get-MigrationUserStatisticsThis example retrieves more detailed information about any ongoing migration for the user with the specified email address.
Parameters
-BatchId
The BatchId parameter specifies the name of the migration batch for which you want to return users.
| Type: | MigrationBatchIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
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.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-EmailAddress
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.
| Type: | EmailAddress |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Identity
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.
| Type: | MigrationUserIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IncludeAssociatedUsers
This parameter is available only in the cloud-based service.
{{ Fill IncludeAssociatedUsers Description }}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-MailboxGuid
The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Partition
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ResultSize
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.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Status
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
| Type: | MigrationUserStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-StatusSummary
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
| Type: | MigrationUserStatusSummary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
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.