Commands › Exchange Online

Suspend-MailboxRestoreRequest

Exchange Online ExchangeOnlineManagement Suspend-*

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.

Quick start script

# Suspend-MailboxRestoreRequest — 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
Suspend-MailboxRestoreRequest -Identity <MailboxRestoreRequestIdParameter> | Format-List

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

Syntax

Suspend-MailboxRestoreRequest [-Identity] <MailboxRestoreRequestIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-SuspendComment <String>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (5)

Parameter	Type	Required	What it controls
-Identity	MailboxRestoreRequestIdParameter	yes	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....
-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.
-SuspendComment	String		The SuspendComment parameter specifies a description about why the request was suspended.
-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.