Commands › Exchange Online

Get-MailboxImportRequest

Exchange Online ExchangeOnlineManagement Get-*

View the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest 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

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

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

Syntax — 2 parameter sets

Identity

Get-MailboxImportRequest [[-Identity] <MailboxImportRequestIdParameter>]
 [-DomainController <Fqdn>]
 [-ResultSize <Unlimited>]
 [<CommonParameters>]

Filtering

Get-MailboxImportRequest [-Mailbox <MailboxLocationIdParameter>]
 [-BatchName <String>]
 [-Database <DatabaseIdParameter>]
 [-DomainController <Fqdn>]
 [-HighPriority <Boolean>]
 [-Name <String>]
 [-ResultSize <Unlimited>]
 [-Status <RequestStatus>]
 [-Suspend <Boolean>]
 [-RequestQueue <DatabaseIdParameter>]
 [<CommonParameters>]

Parameters (11)

Parameter	Type	What it controls
-Identity	MailboxImportRequestIdParameter	The Identity parameter specifies the identity of the import request. By default, import requests are named `<alias>\MailboxImportX` (where X = 0-9). If you specify a name for the import request, use the following...
-BatchName	String	The BatchName parameter specifies the name given to a batch import request.
-Database	DatabaseIdParameter	The Database parameter specifies the database in which the user's mailbox or archive resides. You can use any value that uniquely identifies the database. For example:
-DomainController	Fqdn	This parameter is available only in on-premises Exchange.
-HighPriority	Boolean	This parameter is available only in on-premises Exchange.
-Mailbox	MailboxLocationIdParameter	This parameter is functional only in on-premises Exchange.
-Name	String	The Name parameter specifies that import requests that have the specified name are returned.
-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.
-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.
-RequestQueue	DatabaseIdParameter	This parameter is available only in on-premises Exchange.

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