Remove-PublicFolderMigrationRequest

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PublicFolderMigrationRequest cmdlet to cancel or complete a migration request that was initiated using the New-PublicFolderMigrationRequest cmdlet. You use must this cmdlet to remove the public folder migration request before you can create another public folder migration request.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderMigrationRequest -Identity <PublicFolderMigrationRequestIdParameter> [-Force <SwitchParameter>] <COMMON PARAMETERS>

Remove-PublicFolderMigrationRequest -RequestGuid <Guid> -RequestQueue <DatabaseIdParameter> <COMMON PARAMETERS>

COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example cancels any public folder migration request that's actively running.

Get-PublicFolderMigrationRequest | Remove-PublicFolderMigrationRequest

This example cancels a migration request by using the RequestGuid parameter for a mailbox on MBXDB01.

noteNote:
The RequestGuid and RequestQueue parameters are for debugging purposes only.
Remove-PublicFolderMigrationRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f

The RequestQueue and RequestGuid parameters are for debugging purposes only.

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 "Public folders" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MailboxReplicationService.PublicFolderMigrationRequestIdParameter

The Identity parameter specifies the identity of the public folder migration request.

You can't use this parameter in conjunction with the RequestGuid or RequestQueue parameters.

RequestGuid

Required

System.Guid

This parameter is available only in on-premises Exchange 2016.

The RequestGuid parameter specifies the GUID of the migration request. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter.

You can't use this parameter in conjunction with the Identity parameter.

RequestQueue

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

This parameter is available only in on-premises Exchange 2016.

The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example:

  • Database GUID

  • Database name

You can't use this parameter with the Identity parameter.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

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.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show: