Commands › Exchange Online

Remove-MigrationBatch

Exchange Online ExchangeOnlineManagement Remove-*

Delete a migration batch that either isn't running or is completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it.

Quick start script

# Remove-MigrationBatch — 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-MigrationBatch
$before | Format-List

# 3. Make the change (dry run first)
Remove-MigrationBatch  -WhatIf
Remove-MigrationBatch

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

Syntax

Remove-MigrationBatch [[-Identity] <MigrationBatchIdParameter>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Force]
 [-Partition <MailboxIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (6)

ParameterTypeRequiredWhat it controls
-Identity MigrationBatchIdParameter The Identity parameter identifies the migration batch that you want to remove. The value for this parameter is the name that was specified when the migration batch was created.
-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.
-Force SwitchParameter This parameter is available only in on-premises Exchange.
-Partition MailboxIdParameter This parameter is available only in the cloud-based service.
-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.