Get-VBOOrganizationSite

In this article

    Short Description

    Returns organization sites.

    Syntax

    This cmdlet provides the following parameter sets:

    • Get all organization sites of the specified organization.

    Get-VBOOrganizationSite -Organization <VBOOrganization> [-IncludePersonalSite] [-IncludeSearchSite] [-NotInJob] [-Recurse]  [<CommonParameters>]

    • Get an organization site with the specified URL.

    Get-VBOOrganizationSite -Organization <VBOOrganization> [-URL <string>] [-IncludePersonalSite] [-IncludeSearchSite] [-NotInJob] [-Recurse]  [<CommonParameters>]

    • Get one sub-level children sites to the specified parent organization site.

    Get-VBOOrganizationSite -Organization <VBOOrganization> [-ParentURL <string>] [-IncludePersonalSite] [-IncludeSearchSite] [-NotInJob] [-Recurse]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns organization sites.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Organization

    Specifies an organization. This cmdlet returns organization sites of a specified organization.

    True

    Named

    True (ByValue)

    False

    NotInJob

    Indicates that the cmdlet will return sites that are not assigned to any of the backup jobs.

    Sites that are backed up by the "EntireOrganization" job are considered to be "NotInJob" as well.

    False

    Named

    False

    True

    ParentURL

    Specifies parent organization site URL. If the Recurse parameter is not used, this cmdlet will return one sub-level children of the organization site with this URL.

    False

    Named

    False

    False

    Recurse

    Indicates that the cmdlet will get all sub-levels children sites.

    False

    Named

    False

    False

    URL

    Specifies the organization site URL. If the Recurse parameter is not used, this cmdlet will return organization sites with this URL.

    False

    Named

    False

    False

    IncludePersonalSite

    Indicates that the cmdlet will return personal organization sites together with the rest of the organization sites.

    False

    Named

    False

    False

    IncludeSearchSite

    Indicates that the cmdlet will return search sites together with the rest of the organization sites.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

    Example 1

    This example shows how to get all organization sites for an organization with the name "ABC" that are not backed up by any job:

    1. Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name "ABC". Save the result to the $org variable.
    2. Run the Get-VBOrganizationSite cmdlet with the $org variable to get all organization sites of an organization with the name "ABC". Use the NotInJob parameter to get only organization sites that are not specifically assigned to any backup job. Use the IncludePersonalSite parameter to get personal organization sites as well.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationSite -Organization $org -NotInJob -IncludePersonalSites

    Example 2

    This example shows how to get an organization site under a certain URL and all of its children:

    1. Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name "ABC". Save the result to the $org variable.
    2. Save a certain SharePoint organization site URL address to the $siteUrl variable.
    3. Run the Get-VBOrganizationSite cmdlet with the $org variable and the $siteUrl value for the URL parameter to get an organization site with a specified URL. Use the Recurse parameter to also get all sub-levels children sites. Use the IncludePersonalSite parameter to get personal organization sites as well.

    $org = Get-VBOOrganization -Name "ABC"

    $siteUrl = "https://exampleorganization.sharepoint.com/sites/exampleparentsite"

    Get-VBOOrganizationSite -Organization $org -URL $siteUrl -Recurse

    Example 3

    This example shows how to get only one sub-level children sites to the parent organization site $parentSite:

    1. Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name "ABC". Save the result to the $org variable.
    2. Save a certain SharePoint organization site URL address to the $parentSite variable.
    3. Run the Get-VBOrganizationSite cmdlet with the $org variable and the $parentSite value for the ParentURL parameter to get one sub-level children sites to the $parentSite organization site. Use the IncludePersonalSite parameter to get personal organization sites as well.

    $org = Get-VBOOrganization -Name "ABC"

    $parentSite = "https://exampleorganization.sharepoint.com/sites/exampleparentsite"

    Get-VBOOrganizationSite -Organization $org -ParentURL $parentSite

    Related Commands

    Get-VBOOrganization