Short Description
Returns organization groups.
Syntax
This cmdlet provides 2 parameter sets.
- For getting all organization groups:
Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob] [<CommonParameters>] |
- For returning an organization group by name:
Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Name <string>] [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob] [<CommonParameters>] |
Detailed Description
This cmdlet returns Exchange and Microsoft Office 365 SharePoint organization groups.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Name | Specifies the name of the organization group. This cmdlet returns organization groups with this name. | False | Named | False | False |
NotInJob | Indicates that the cmdlet will return groups that are not assigned to any of the backup jobs. Groups 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 returns organization groups of a specified organization. | True | Named | True (ByValue) | False |
Type | Specifies the type of the organization group:
This cmdlet returns organization group with this type. It will not return organization groups of an On-Premises organization with SharePoint components. | 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 groups in the "ABC" organization:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Run Get-VBOrganizationGroup with the $org variable to get all organization groups of an organization with a name "ABC".
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> Get-VBOOrganizationGroup -Organization $org |
Example 2
This example shows how to get an organization group with a name "UsersAlpha" from the "ABC" organization:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Run Get-VBOrganizationGroup with the $org variable and a Name parameter to get an organization group with a name "UsersAlpha".
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> Get-VBOOrganizationGroup -Organization $org -Name "UsersAlpha" |
Example 3
This example shows how to get all organization groups with a name starting with "A" of an Office 365 type that are not specifically assigned to any backup 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-VBOrganizationGroup with the $org variable, a Name parameter and a specified Type parameter to get an organization group of an Office365 type with a name starting with "A". use NotInJob parameter to get only organization groups that are not specifically assigned to any backup job.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> Get-VBOOrganizationGroup -Organization $org -Name "A*" -Type Office365 -NotInJob |
