Short Description
Returns organization sites.
Syntax
This cmdlet provides 3 parameter sets.
- For getting all organization sites of the specified organization:
Get-VBOOrganizationSite -Organization <VBOOrganization> [-IncludePersonalSite] [-IncludeSearchSite] [-NotInJob] [-Recurse] [<CommonParameters>] |
- For getting an organization site with the specified URL:
Get-VBOOrganizationSite -Organization <VBOOrganization> [-URL <string>] [-IncludePersonalSite] [-IncludeSearchSite] [-NotInJob] [-Recurse] [<CommonParameters>] |
- For getting 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 | Accept |
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 |
Organization | Specifies an organization. This cmdlet will return organization sites of the specified organization. | True | Named | True (ByValue) | False |
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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This example shows how to get all organization sites for an organization with a name "ABC" that are not backed up by any job:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Run Get-VBOrganizationSite with the $org variable to get all organization sites of an organization with a name "ABC". Use NotInJob parameter to get only organization sites that are not specifically assigned to any backup job. Use IncludePersonalSite parameter to get personal organization sites as well.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> 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:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Save a certain SharePoint organization site URL address to the $siteUrl variable.
- Run Get-VBOrganizationSite with the $org variable and the $siteUrl value for the URL parameter to get an organization site with a specified URL. Use Recurse parameter to also get all sub-levels children sites. Use IncludePersonalSite parameter to get personal organization sites as well.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> $siteUrl = https://exampleorganization.sharepoint.com/sites/exampleparentsite PS C:\PS> 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:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Save a certain SharePoint organization site URL address to the $parentSite variable.
- Run Get-VBOrganizationSite 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 IncludePersonalSite parameter to get personal organization sites as well.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> $parentSite = https://exampleorganization.sharepoint.com/sites/exampleparentsite PS C:\PS> Get-VBOOrganizationSite -Organization $org -ParentURL $parentSite |
