Commands › Exchange Online

Get-MigrationBatch

Exchange Online ExchangeOnlineManagement Get-*

Retrieve status information about the current migration batch.

Quick start script

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

# 2. Run and inspect
Get-MigrationBatch | Format-List

# 3. Export for evidence / drift tracking
Get-MigrationBatch | Export-Clixml .\MigrationBatch-$(Get-Date -Format yyyyMMdd).xml

Syntax — 4 parameter sets

Identity

Get-MigrationBatch [[-Identity] <MigrationBatchIdParameter>]
 [-Diagnostic]
 [-DiagnosticArgument <String>]
 [-DiagnosticInfo <String>]
 [-DomainController <Fqdn>]
 [-IncludeReport]
 [-Partition <MailboxIdParameter>]
 [-ResultSize <Unlimited>]
 [-Status <MigrationBatchStatus>]
 [<CommonParameters>]

BatchesFromEndpoint

Get-MigrationBatch
 [-Diagnostic]
 [-DiagnosticArgument <String>]
 [-DomainController <Fqdn>]
 [-Endpoint <MigrationEndpointIdParameter>]
 [-IncludeReport]
 [-Status <MigrationBatchStatus>]
 [<CommonParameters>]

BatchesByEndpoint

Get-MigrationBatch
 [-DiagnosticInfo <String>]
 [-Endpoint <MigrationEndpointIdParameter>]
 [-IncludeReport]
 [-Partition <MailboxIdParameter>]
 [-ResultSize <Unlimited>]
 [<CommonParameters>]

BatchesByStatus

Get-MigrationBatch
 [-DiagnosticInfo <String>]
 [-IncludeReport]
 [-Partition <MailboxIdParameter>]
 [-ResultSize <Unlimited>]
 [-Status <MigrationBatchStatus>]
 [<CommonParameters>]

Parameters (10)

Parameter	Type	What it controls
-Identity	MigrationBatchIdParameter	The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet.
-Diagnostic	SwitchParameter	This parameter is available only in on-premises Exchange.
-DiagnosticArgument	String	This parameter is available only in on-premises Exchange.
-DiagnosticInfo	String	This parameter is available only in the cloud-based service.
-DomainController	Fqdn	This parameter is available only in on-premises Exchange.
-Endpoint	MigrationEndpointIdParameter	The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint.
-IncludeReport	SwitchParameter	The IncludeReport switch returns additional information about the specified migration batch. You don't need to specify a value with this switch.
-Partition	MailboxIdParameter	This parameter is available only in the cloud-based service.
-ResultSize	Unlimited	This parameter is available only in the cloud-based service.
-Status	MigrationBatchStatus	The Status parameter returns a list of migration batches that have the specified status state. Use one of the following values:

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