Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-11
Use the Stop-MigrationBatch cmdlet to stop the processing of a migration batch that's in progress.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Stop-MigrationBatch [-Identity
<MigrationBatchIdParameter>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Organization <OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example stops the migration batch that's currently being processed by the migration service.
 Copy Code |
|
|---|---|
Stop-MigrationBatch |
|
EXAMPLE 2
This example stops the migration batch MigrationBatch1.
| Copy Code |
|
|---|---|
Stop-MigrationBatch -Identity MigrationBatch1 |
|
Detailed Description
The Stop-MigrationBatch cmdlet stops the migration batch that's being processed in your on-premises Exchange organization or by the cloud-based migration service running in Microsoft Office 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration won't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet won't run.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Mailbox move and migration permissions" section in the Recipients Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. This parameter applies to objects in on-premises deployments. It isn't available in the cloud-based service. |
|
Identity |
Optional |
Microsoft.Exchange.Management.Migration.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. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.
Return 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.