Applies to: Exchange Server 2013
Topic Last Modified: 2012-08-09
Use the Suspend-MailboxRestoreRequest cmdlet to suspend a restore request any time after the request was created, but before the request reaches the status of Completed. You can resume the restore request by using the Resume-MailboxRestoreRequest cmdlet.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Suspend-MailboxRestoreRequest -Identity
<MailboxRestoreRequestIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-SuspendComment <String>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example suspends the second restore request for Ayla's mailbox with the identity Ayla\MailboxRestore1.
 Copy Code |
|
|---|---|
Suspend-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" |
|
EXAMPLE 2
This example suspends all restore requests that are in
progress by using the Get-MailboxRestoreRequest
cmdlet to retrieve all requests with a status of
InProgress, and then pipelines the output to the
Suspend-MailboxRestoreRequest cmdlet with the suspend
comment "Resume after 10:00 PM."
| Copy Code |
|
|---|---|
Get-MailboxRestoreRequest -Status InProgress | Suspend-MailboxRestoreRequest -SuspendComment "Resume after 10:00 PM" |
|
Detailed Description
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 restore request" entry in the Recipients Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Management.RecipientTasks.MailboxRestoreRequestIdParameter |
The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: <alias>\<name>. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1–9). |
|
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. |
|
SuspendComment |
Optional |
System.String |
The SuspendComment parameter specifies a description about why the request was suspended. |
|
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.