Get-VESPList - Veeam Backup for Microsoft Office 365 PowerShell Reference
Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Get-VESPList

Short Description

Returns SharePoint lists.

Syntax

This cmdlet provides 2 parameter sets.

  • For getting lists from a SharePoint organizat ion:

Get-VESPList [-Organization] <VESPOrganization> [[-Name] <string[]>]  [<CommonParameters>]

  • For getting lists from a SharePoint site:

Get-VESPList [-Site] <VESPSite> [[-Name] <string[]>] [-Recurse]  [<CommonParameters>]

Detailed Description

This cmdlet returns lists.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name of the SharePoint item. This cmdlet will return SharePoint lists with the specified name.

False

1

False

True

Organization

Specifies an organization. The cmdlet will return the SharePoint lists from this organization.

True

0

True (ByValue)

False

Site

Specifies the name of the SharePoint site. This cmdlet will return SharePoint lists from the specified SharePoint site.

True

0

True (ByValue)

False

Recurse

Indicates that the cmdlet will return items from all subfolders of the specified parent folder.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to get SharePoint list with a name "Color names list" from the SharePoint organization with a name "ABC".

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with a name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPList with the $organization variable and Name parameter to get the list with a name "Color names list".

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> Get-VESPList -Organization $organization -Name "Color names list"

Example 2

This example shows how to get SharePoint list with a name "Color names list" from a SharePoint site with a name "Team Site".

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with a name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPSite with the $organization variable and and Name parameter to get a SharePoint site with a name "Team Site".
  4. Run Get-VESPList with the $site variable and Name parameter to get the list with a name "Color names list".

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> $site = Get-VESPSite -Organization $organization -Name "Team Site"

PS C:\PS> Get-VESPList -Site $site -Name "Color names list"

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference