Start-VBOTeamsItemRestoreSession

Short Description

Starts restore sessions to explore backed-up Microsoft Teams objects and to perform operations with these items.

Product: Veeam Backup for Microsoft 365

Product Edition: Community, Rental License, Subscription License

Syntax

This cmdlet provides the following parameter sets:

LatestState (Default)

Start-VBOTeamsItemRestoreSession [-LatestState] [-Job <IVBOJob>] [-Organization <IVBOOrganization>]

[-ShowDeleted] [-ShowAllVersions] [<CommonParameters>]
RestorePoint

Start-VBOTeamsItemRestoreSession -RestorePoint <IVBORestorePoint> [-Job <IVBOJob>]

[-Organization <IVBOOrganization>] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>]
Remote

Start-VBOTeamsItemRestoreSession -Server <String> -Credential <PSCredential> [-Port <Int32>] [-ShowDeleted]

[-ShowAllVersions] [<CommonParameters>]

Detailed Description

This cmdlet establishes a connection to the Veeam Backup for Microsoft 365 server and retrieves Microsoft Teams objects backed up on this server. Within the restore session, you can get backed-up Microsoft Teams objects using the following cmdlets:

After you get backed-up Microsoft Teams objects, you can perform the following operations with these objects:

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credential	Specifies credentials that will be used for authenticating to the Veeam Backup for Microsoft 365 server. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	True	Named	False
Job	Specifies a backup job to start a new restore session. You will be able to use the session to perform operations with items backed up by this job. Accepts the `IVBOJob` object. To get this object, run the `Get-VBOJob` cmdlet.	`IVBOJob`	False	Named	True (ByValue)
LatestState	Defines that the cmdlet will retrieve items from the latest restore point in the backup. Default: False	`SwitchParameter`	True	Named	False
Organization	Specifies an organization to start a new restore session. You will be able to use the session to perform operations with items backed up for this organization. Accepts the `IVBOOrganization` object. To get this object, run the `Get-VBOOrganization` cmdlet.	`IVBOOrganization`	False	Named	True (ByValue)
Port	Specifies a port number that will be used to connect to the Veeam Backup for Microsoft 365 server.	`Int32`	False	Named	False
RestorePoint	Specifies a restore point to start a new restore session. You will be able to use the session to perform operations with items that this restore point contains. Accepts the `IVBORestorePoint` object. To get this object, run the `Get-VBORestorePoint` cmdlet.	`IVBORestorePoint`	True	Named	True (ByValue)
Server	Specifies DNS name or IP address of the Veeam Backup for Microsoft 365 server that backed up items that you want to restore.	`String`	True	Named	False
ShowAllVersions	Defines that all versions of Microsoft Teams items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items. Default: False Note: If you provide this parameter, the amount of data returned by cmdlets within the current session may significantly increase.	`SwitchParameter`	False	Named	False
ShowDeleted	Defines that deleted items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items. Default: False Note: If you provide this parameter, the amount of data returned by cmdlets within the current session may significantly increase.	`SwitchParameter`	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

The cmdlet returns the VBOTeamsRestoreSession object that contains the restore session started to perform operations with backed-up Microsoft Teams objects.

Examples

Start-VBOTeamsItemRestoreSession Example 1. Starting Restore Session from Latest Restore Point

This example shows how to start a restore session to perform operations with Microsoft Teams objects. The restore session will start with the following settings:

The cmdlet will retrieve data from a backup at the state of the latest restore point.
The cmdlet will start a restore session only for backups associated with the ABC organization.

$org = Get-VBOOrganization -Name "ABC"

Start-VBOTeamsItemRestoreSession -LatestState -Organization $org

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Start-VBOTeamsItemRestoreSession cmdlet. Provide the LatestState parameter. Set the $org variable as the Organization parameter value.

Start-VBOTeamsItemRestoreSession Example 2. Starting Restore Session from Specific Restore Point

This example shows how to start a restore session to perform operations with Microsoft Teams objects. The restore session will start with the following settings:

The cmdlet will retrieve data from a backup at the state of the selected restore point.
The cmdlet will start a restore session only for backups that were created by the Sales Backup backup job.

$restorepoint = Get-VBORestorePoint

$job = Get-VBOJob -Name "Sales Backup"

Start-VBOTeamsItemRestoreSession -RestorePoint $restorepoint[2] -Job $job

Perform the following steps:

Run the Get-VBORestorePoint cmdlet. Save the result to the $restorepoint variable.

The cmdlet will return an array of restore points. Note the ordinal number of the necessary restore point. In this example, it is the third restore point in the array.
Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Start-VBOTeamsItemRestoreSession cmdlet. Set the $restorepoint[2] variable as the RestorePoint parameter value. Set the $job variable as the Job parameter value.

Start-VBOTeamsItemRestoreSession Example 3. Performing Restore Scenario

This example shows how to perform a restore scenario. The restore scenario includes the following steps:

Start a remote restore session for a backup at the state of the latest restore point.
Perform an item restore from a Microsoft Teams team.
Stop a restore session.

$vbosrvcreds = Get-Credential

$session = Start-VBOTeamsItemRestoreSession -LatestState -Server vbo365server.support.local -Credential $vbosrvcreds

$org = Get-VETOrganization -Session $session -Name "ABC*"

$team = Get-VETTeam -Organization $org -DisplayName "IT"

$file = Get-VETFile -Team $team -Query "filename: report"

$orgcreds = Get-Credential

Restore-VETItem -Credential $orgcreds -File $file -RestoreChangedItem -RestoreMissingItem

Stop-VBOTeamsItemRestoreSession -Session $session

Perform the following steps:

Start the remote restore session at the state of the latest restore point:
1. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft 365 server. Save the result to the $vbosrvcreds variable.
2. Run the Start-VBOTeamsItemRestoreSession cmdlet. Provide the LatestState parameter value. Specify the Server parameter value. Set the $vbosrvcreds variable as the Credential parameter value. Save the result to the $session variable.
Perform item restore:
1. Get files that you want to restore:
  1. Run the Get-VETOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $org variable.
  2. Run the Get-VETTeam cmdlet. Set the $org variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $team variable.
  3. Run the Get-VETFile cmdlet. Set the $team variable as the Team parameter value. Specify the Query parameter value. Save the result to the $file variable.
2. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Microsoft Teams organization. Save the result to the $orgcreds variable.
3. Run the Restore-VETitem cmdlet. Set the $orgcreds variable as the Credential parameter value. Set the $file variable as the File parameter value. Provide the RestoreChangedItem and RestoreMissingItem parameter values.
Run the Stop-VBOTeamsItemRestoreSession cmdlet. Set the $session variable as the Session parameter value.