Restore-VEXItem
Short Description
Restores backups of Exchange mailboxes.
Applies to
Veeam Backup & Replication, Veeam Backup for Microsoft 365
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Restore Exchange mailboxes.
Restore-VEXItem -Mailbox <VEXMailbox> [-ApplicationId <guid>] [-ApplicationCertificatePath <string>] [-ApplicationCertificatePassword <securestring>] [-ImpersonationAccountName <string>] [-OrganizationName <string>] [-Region {Worldwide | Germany | China | USDefence | USGovernment}] [-Server <string>] [-TargetMailbox <string>] [-Credential <pscredential>] [-ToFolder <string>] [-RestoreChangedItem] [-RestoreDeletedItem] [-MarkAsUnread] [-Force] [-ExcludeDrafts] [-ExcludeDeletedItems] [-ExcludeInPlaceHoldItems] [-ExcludeLitigationHoldItems] [<CommonParameters>] |
- Restore Exchange mailbox folders.
Restore-VEXItem -Folder <VEXFolder> [-ApplicationId <guid>] [-ApplicationCertificatePath <string>] [-ApplicationCertificatePassword <securestring>] [-ImpersonationAccountName <string>] [-OrganizationName <string>] [-Region {Worldwide | Germany | China | USDefence | USGovernment}] [-Server <string>] [-TargetMailbox <string>] [-Credential <pscredential>] [-ToFolder <string>] [-RestoreChangedItem] [-RestoreDeletedItem] [-MarkAsUnread] [-Force] [<CommonParameters>] |
- Restore Exchange mailbox items.
Restore-VEXItem -Item <VEXItem[]> [-ApplicationId <guid>] [-ApplicationCertificatePath <string>] [-ApplicationCertificatePassword <securestring>] [-ImpersonationAccountName <string>] [-OrganizationName <string>] [-Region {Worldwide | Germany | China | USDefence | USGovernment}] [-Server <string>] [-TargetMailbox <string>] [-Credential <pscredential>] [-ToFolder <string>] [-RestoreChangedItem] [-RestoreDeletedItem] [-MarkAsUnread] [-Force] [<CommonParameters>] |
- Restore multiple Exchange organization mailboxes.
Restore-VEXItem -MultipleMailboxes <VEXMailbox[]> [-SkipUnresolvedMailboxes] [-RestoreItemsForLastDays <int>] [-Office365Credential <pscredential>] [-ApplicationId <guid>] [-ApplicationCertificatePath <string>] [-ApplicationCertificatePassword <securestring>] [-ImpersonationAccountName <string>] [-Region {Worldwide | Germany | China | USDefence | USGovernment}] [-Domain <string>] [-Server <string>] [-Credential <pscredential>] [-RestoreChangedItem] [-RestoreDeletedItem] [-MarkAsUnread] [-Force] [-ExcludeDrafts] [-ExcludeDeletedItems] [-ExcludeInPlaceHoldItems] [-ExcludeLitigationHoldItems] [<CommonParameters>] |
Detailed Description
This cmdlet restores backups of Exchange organization mailboxes. You can restore Exchange organization mailboxes with one of the following authentication methods:
- Authentication methods that utilize legacy protocols.
- Multi-factor authentication. To restore data the cmdlet utilizes an Azure AD application.
|
|
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Item | Specifies an array of items for an Exchange organization mailbox. The cmdlet will restore these items. | Accepts the VEXItem[] object. To get this object, run the Get-VEXItem cmdlet. | True | Named | True (ByValue) |
Folder | Specifies a folder of an Exchange organization mailbox. The cmdlet will restore this folder with all its subfolders. | Accepts the VEXFolder object. To get this object, run the Get-VEXFolder cmdlet. | True | Named | True (ByValue) |
Mailbox | Specifies an Exchange organization mailbox that you want to restore. | Accepts the VEXMailbox object. To get this object, run the Get-VEXMailbox cmdlet. | True | Named | True (ByValue) |
MultipleMailboxes | Specifies an Exchange organization multiple mailboxes that you want to restore. | Accepts the VEXMailbox[] object. To get this object, run the Get-VEXMailbox cmdlet. | True | Named | True (ByValue) |
ApplicationId | To restore data using Multi-factor authentication. Specifies an ID of an Azure AD application. The cmdlet will use this application ID to set up a secure connection to a Microsoft organization. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 version 4c or later. | Guid | False | Named | False |
ApplicationCertificatePath | To restore data using Multi-factor authentication. Specifies a path to the certificate. The cmdlet will import this certificate that is located in this path to set up an encrypted connection to a Microsoft organization. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 version 4c or later. | String | False | Named | False |
ApplicationCertificatePassword | To restore data using Multi-factor authentication. Specifies the certificate password. The cmdlet will use this password to confirm the certificate that you want to import to an Azure AD application. This parameter is obligatory. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 version 4c or later. | SecureString | False | Named | False |
ImpersonationAccountName | To restore data using Multi-factor authentication. Specifies a user name of a Microsoft Exchange user. The cmdlet will use this user name to authenticate against the Microsoft Exchange server. Use this parameter together with the ApplicationCertificatePassword parameter. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 version 4c or later. | String | False | Named | False |
OrganizationName | To restore data to another organization. Specifies an organization name. The cmdlet will restore an Exchange mailbox to this organization. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 only. | String | False | Named | False |
Region | To restore data to another organization. Specifies the Microsoft Azure region. The cmdlet will restore Exchange mailbox to a Microsoft organization that belongs to one of the following regions:
Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 only. | VBOOffice365Region | False | Named | False |
Server | Specifies the Microsoft Exchange server with the Client Access Server (CAS) role. The cmdlet will perform a restore to this mailbox server. | String | False | Named | False |
TargetMailbox | Specifies an Exchange organization mailbox. The cmdlet will perform a restore to this mailbox. Note: The mailbox must be in the username@domain format. If this parameter is omitted, the cmdlet will perform a restore to the same mailbox on the production Exchange server. | String | False | Named | False |
Credential | Specifies account credentials that you want to use for connecting to the Microsoft Exchange server. If omitted, the cmdlet will use a currently logged in user Windows account credentials to connect to the Microsoft Exchange server. | Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet. | False | Named | False |
ToFolder | Specifies a mailbox folder. The cmdlet will restore backups to this folder. | String | False | Named | False |
RestoreChangedItem | Defines that the cmdlet will restore all versions of mailbox items that were modified by the user. | SwitchParameter | False | Named | False |
RestoreDeletedItem | Defines that the cmdlet will restore mailbox items that were deleted by the user. | SwitchParameter | False | Named | False |
MarkAsUnread | Defines that the cmdlet will mark the restored mailbox items as unread. | SwitchParameter | False | Named | False |
ExcludeDeletedItems | Defines that the cmdlet will not restore the Deleted Items folder. | SwitchParameter | False | Named | False |
ExcludeDrafts | Defines that the cmdlet will not restore the Drafts folder. | SwitchParameter | False | Named | False |
ExcludeInPlaceHoldItems | Defines that the cmdlet will not restore mailbox items that have been placed on hold. | SwitchParameter | False | Named | False |
ExcludeLitigationHoldItems | Defines that the cmdlet will not restore the mailbox items that have been placed on Litigation Hold. | SwitchParameter | False | Named | False |
Force | Defines that the cmdlet will perform a restore without notifying a user. | SwitchParameter | False | Named | False |
SkipUnresolvedMailboxes | Defines that the cmdlet will not restore mailboxes that do not resolve. | SwitchParameter | False | Named | False |
RestoreItemsForLastDays | Specifies the number of subsequent past days from which this cmdlet will restore the items from the selected users in the first place. | Int | False | Named | False |
Office365Credential | Specifies the account credentials that you want to use for connecting to the Microsoft Office365 server. | PsCredential | False | Named | False |
Domain | Specifies the Exchange organization domain. | String | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.
Output Object
None.
Examples
Example 1. Restoring Exchange Mailbox [For Veeam Backup & Replication]
This example shows how to restore the Sales mailbox with the following settings:
Perform the following steps:
|
Example 2. Restoring Mailbox Folder [For Veeam Backup & Replication]
This example shows how to restore the Contacts folder with the following settings:
Perform the following steps:
|
Example 3. Restoring all Mailbox Items [For Veeam Backup & Replication]
This example shows how to restore all mailbox items with the following settings:
Perform the following steps:
|
Example 4. Restoring Multiple Mailboxes [For Veeam Backup & Replication]
This example shows how to restore multiple Exchange mailboxes with the following settings:
Perform the following steps:
|
Example 5. Restoring Exchange Mailbox [For Veeam Backup for Microsoft 365]
This example shows how to restore the Sales mailbox with the following settings:
Perform the following steps:
|
Example 6. Restoring Exchange Mailbox Using Multi-Factor Authentication with Azure AD Application ID [For Veeam Backup for Microsoft 365]
This example shows how to restore the Sales mailbox with the following settings:
Perform the following steps:
|
Example 7. Restoring Exchange Mailbox Using Multi-Factor Authentication with Azure AD Application [For Veeam Backup for Microsoft 365]
This example shows how to restore the Sales mailbox with the following settings:
Perform the following steps:
|
Example 8. Restoring Folder [For Veeam Backup for Microsoft 365]
This example shows how to restore the Contacts folder with the following settings:
Perform the following steps:
|
Example 9. Restoring all Mailbox Items [For Veeam Backup for Microsoft 365]
This example shows how to restore all mailbox items with the following settings:
Perform the following steps:
|
Example 10. Restoring Exchange Mailbox Using Multi-Factor Authentication [For Veeam Backup for Microsoft 365]
This example shows how to restore mailbox items to the same organization with the following settings:
Perform the following steps:
|
Example 11. Restoring Exchange Mailbox to Different Organization [For Veeam Backup for Microsoft 365]
This example shows how to restore mailbox items to a different organization with the following settings:
Perform the following steps:
|
Example 12. Restoring Exchange Mailbox to Different Organization Using Multi-Factor Authentication with Azure Application ID [For Veeam Backup for Microsoft 365]
This example shows how to restore mailbox items to the tech.onmicrosoft.com organization with the following settings:
Perform the following steps:
|
Related Commands