Get-MailboxRestoreRequest
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
Use the Get-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-MailboxRestoreRequest
[[-Identity] <MailboxRestoreRequestIdParameter>]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>] 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>] Description
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Get-MailboxRestoreRequest -Identity "Ayla\MailboxRestore"This example returns the status of the in-progress and queued restore request with the identity ayla\MailboxRestore, where Ayla is the first name of the user.
Example 2
Get-MailboxRestoreRequest -TargetDatabase MBD01In Exchange Server 2010, this example returns the status of in progress and queued restore requests that are being restored to the target database MBD01.
Example 3
Get-MailboxRestoreRequest -RequestQueue MBD01This example returns the status of in-progress and queued restore requests that are being restored to the mailbox database MBD01.
Example 4
Get-MailboxRestoreRequest -Name "RestoreToMBD01" -Suspend $trueThis example returns all restore requests that have the name RestoreToMBD01 where the restore request has been suspended.
Parameters
-BatchName
The BatchName parameter specifies the name given to a batch of restore requests.
You can't use this parameter with the Identity parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
This parameter is available only in on-premises Exchange.
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 (FQDN). For example, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-HighPriority
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:
- $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency.
- $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest.
You can't use this parameter with the Identity parameter.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
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. The identity of the restore request uses the following syntax: Alias\Name.
If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9).
You can't use this parameter with the Name parameter.
| Type: | MailboxRestoreRequestIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Name
The Name parameter specifies that any restore request that has the specified name is returned.
Use this parameter to search on the name you provided when you created the restore request.
If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9).
You can't use this parameter with the Identity parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RequestQueue
This parameter is available only in on-premises Exchange.
The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example:
- Name
- Distinguished name (DN)
- GUID
You can't use this parameter with the Identity parameter.
| Type: | DatabaseIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-ResultSize
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.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SourceDatabase
This parameter is available only in on-premises Exchange.
The SourceDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that are being restored from the specified source database. You can use any value that uniquely identifies the database. For example:
- Name
- Distinguished name (DN)
- GUID
You can't use this parameter with the Identity parameter.
| Type: | DatabaseIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Status
The Status parameter filters the results based on status. You can use the following values:
- AutoSuspended
- Completed
- CompletedWithWarning
- CompletionInProgress
- Failed
- InProgress
- Queued
- Retrying
- Suspended
- Synced
You can't use this parameter with the Identity parameter.
| Type: | RequestStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Suspend
The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false.
You can't use this parameter with the Identity parameter.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-TargetDatabase
This parameter is available only in Exchange Server 2010.
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:
- Name
- Distinguished name (DN)
- GUID
You can't use this parameter with the Identity parameter.
| Type: | DatabaseIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-TargetMailbox
The TargetMailbox parameter specifies the identity of the target mailbox. You can use the following values:
- GUID
- Distinguished name (DN)
- Domain\Account
- User principal name (UPN)
- Legacy Exchange DN
- SMTP address
- Alias
You can't use this parameter with the Identity parameter.
| Type: | MailboxOrMailUserIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Inputs
Input types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
Outputs
Output types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn't return data.