Commands › Exchange Online

Get-MailboxRestoreRequest

Exchange Online ExchangeOnlineManagement Get-*

View detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet.

Quick start script

# Get-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
Get-MailboxRestoreRequest | Format-List

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

Syntax — 2 parameter sets

Identity

Get-MailboxRestoreRequest [[-Identity] <MailboxRestoreRequestIdParameter>]
 [-DomainController <Fqdn>]
 [-ResultSize <Unlimited>]
 [<CommonParameters>]

Filtering

Get-MailboxRestoreRequest [-BatchName <String>]
 [-HighPriority <Boolean>]
 [-Name <String>]
 [-RequestQueue <DatabaseIdParameter>]
 [-SourceDatabase <DatabaseIdParameter>]
 [-Status <RequestStatus>]
 [-Suspend <Boolean>]
 [-TargetDatabase <DatabaseIdParameter>]
 [-TargetMailbox <MailboxOrMailUserIdParameter>]
 [-DomainController <Fqdn>]
 [-ResultSize <Unlimited>]
 [<CommonParameters>]

Parameters (12)

ParameterTypeRequiredWhat it controls
-Identity 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....
-BatchName String The BatchName parameter specifies the name given to a batch of restore requests.
-DomainController Fqdn This parameter is available only in on-premises Exchange.
-HighPriority Boolean The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results:
-Name String The Name parameter specifies that any restore request that has the specified name is returned.
-RequestQueue DatabaseIdParameter This parameter is available only in on-premises Exchange.
-ResultSize Unlimited The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
-SourceDatabase DatabaseIdParameter This parameter is available only in on-premises Exchange.
-Status RequestStatus The Status parameter filters the results based on status. You can use the following values:
-Suspend Boolean The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false.
-TargetDatabase DatabaseIdParameter The TargetDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that reside on the target database. You can use any value that uniquely identifies the database. For example:
-TargetMailbox MailboxOrMailUserIdParameter The TargetMailbox parameter specifies the identity of the target mailbox. You can use the following values:

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.