Commands › Exchange Online

Suspend-MailboxExportRequest

Exchange Online ExchangeOnlineManagement Suspend-*

Suspend an export request any time after the request was created, but before the request reaches the status of Completed. You can resume the request by using the Resume-MailboxExportRequest cmdlet. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

Quick start script

# Suspend-MailboxExportRequest — 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-MailboxExportRequest -Identity <MailboxExportRequestIdParameter> | Format-List

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

Syntax

Suspend-MailboxExportRequest [-Identity] <MailboxExportRequestIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-SuspendComment <String>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (5)

Parameter	Type	Required	What it controls
-Identity	MailboxExportRequestIdParameter	yes	The Identity parameter specifies the identity of the export request. By default, export requests are named `<alias>\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`.
-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		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...
-SuspendComment	String		The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter.
-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.