Skip to content

moveRequests

Mailbox Move Jobs. Jobs that move a mailbox between databases or to the cloud. The moveRequests entity set lives under /exchange/v1.0/moveRequests in the Migration & jobs category.

Fact Value
Path /exchange/v1.0/moveRequests
Category Migration & jobs
Tier Tier 6, Mailbox jobs
Read role MailboxJobs.Read.All (Community)
Write role none (read-only)
Backing cmdlets Get-MoveRequest, Set-MoveRequest, New-MoveRequest, Remove-MoveRequest, Resume-MoveRequest, Suspend-MoveRequest, Get-MoveRequestStatistics
Method Path Synopsis Role Plan
GET /exchange/v1.0/moveRequests List moveRequests entries. MailboxJobs.Read Community
GET /exchange/v1.0/moveRequests/{key} Get a single moveRequests entry by Identity. MailboxJobs.Read Community
GET /exchange/v1.0/moveRequests/{key}/statistics Get-MoveRequestStatistics - per-request progress + diagnostics. MailboxJobs.Read Community

List moveRequests entries.

Backing cmdlet: Get-MoveRequest. Role: MailboxJobs.Read (Community).

Parameter In Type Required Description
status query string Filter requests by status (Get-MoveRequest -Status). One of: AutoSuspended, Completed, CompletedWithSkippedItems, CompletedWithWarning, CompletionInProgress, Failed, InProgress, Queued, Retrying, Suspended, Synced.
suspend query bool (switch) Return only moves that have been suspended (Get-MoveRequest -Suspend $true) - pass false to exclude suspended moves. Cannot be combined with a single-Identity lookup.
all query bool (switch) Return all results instead of the EXO default of 1000. Maps -ResultSize Unlimited on Get-MoveRequest; prevents silent truncation in large tenants.
batchName query string
offline query bool (switch)
proxyToMailbox query string
remoteHostName query string
suspendWhenReadyToComplete query bool (switch)

Stub auto-generated example for the moveRequests collection. Backing cmdlet: Get-MoveRequest. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/moveRequests?$top=3 HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#moveRequests",
"value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/moveRequests/{key}

Get a single moveRequests entry by Identity.

Backing cmdlet: Get-MoveRequest. Role: MailboxJobs.Read (Community).

Stub auto-generated example for GET /moveRequests/{key}. Backing cmdlet: Get-MoveRequest with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/moveRequests/{key} HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#moveRequests/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/moveRequests

GET /exchange/v1.0/moveRequests/{key}/statistics

Section titled “GET /exchange/v1.0/moveRequests/{key}/statistics”

Get-MoveRequestStatistics - per-request progress + diagnostics.

Backing cmdlet: Get-MoveRequestStatistics. Role: MailboxJobs.Read (Community).

Parameter In Type Required Description
includeReport query bool (switch) Return additional troubleshooting detail in the Report field (Get-MoveRequestStatistics -IncludeReport).
proxyToMailbox query string