Commands › Exchange Online

Set-MigrationUser

Exchange Online ExchangeOnlineManagement Set-*

This cmdlet is functional only in the cloud-based service. Use the Set-MigrationUser cmdlet to modify the migration settings of a user in an existing migration batch.

Quick start script

# Set-MigrationUser — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-MigrationUser
$before | Format-List

# 3. Make the change (dry run first)
Set-MigrationUser -Identity <MigrationUserIdParameter> -WhatIf
Set-MigrationUser -Identity <MigrationUserIdParameter>

# 4. Verify and diff
$after = Get-MigrationUser
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-MigrationUser [-Identity] <MigrationUserIdParameter>
 [-ApproveSkippedItems]
 [-BadItemLimit <Unlimited>]
 [-CompleteAfter <DateTime>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-LargeItemLimit <Unlimited>]
 [-Partition <MailboxIdParameter>]
 [-StartAfter <DateTime>]
 [-SyncNow]
 [-WhatIf]
 [<CommonParameters>]

Parameters (11)

Parameter	Type	Required	What it controls
-Identity	MigrationUserIdParameter	yes	The Identity parameter specifies the email address of the user that's being migrated.
-ApproveSkippedItems	SwitchParameter		This parameter is available only in the cloud-based service.
-BadItemLimit	Unlimited		This parameter is available only in on-premises Exchange.
-CompleteAfter	DateTime		This parameter is available only in the cloud-based service.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DomainController	Fqdn		This parameter is available only in on-premises Exchange.
-LargeItemLimit	Unlimited		This parameter is available only in on-premises Exchange.
-Partition	MailboxIdParameter		This parameter is available only in the cloud-based service.
-StartAfter	DateTime		This parameter is available only in the cloud-based service.
-SyncNow	SwitchParameter		The SyncNow switch specifies whether to trigger an incremental sync for the migrated user. You don't need to specify a value with this switch.
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.