Get-VBOOrganizationGroup

Short Description

Returns organization groups.

Syntax

This cmdlet provides the following parameter sets:

All (Default)

Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Limit <UInt64>] [-Type <VBOOrganizationGroupType>]

[-NotInJob] [-LocationFilter <VBOLocationFilters>] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>]

ByName

Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Name <String>] [-DisplayName <String>]

[-GroupName <String>] [-Limit <UInt64>] [-Type <VBOOrganizationGroupType>] [-NotInJob]

[-LocationFilter <VBOLocationFilters>] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>]

ById

Get-VBOOrganizationGroup -Organization <VBOOrganization> [-OfficeId <Guid>] [-OnPremisesId <Guid>]

[-Type <VBOOrganizationGroupType>] [-NotInJob] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>]

Detailed Description

This cmdlet returns Microsoft Exchange and Microsoft SharePoint organization groups.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
DataSource	Specifies how the cmdlet will return organization groups: `PreferLocal` For Microsoft organizations with modern app-only authentication, the cmdlet will return data from either the organization cache database if organization objects are already synchronized to this source, or directly from the organization if synchronization is in progress. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, the cmdlet will return data directly from the organization. `Production` The cmdlet will return data directly from the organization. `PreferLocalResynced` For Microsoft organizations with modern app-only authentication, the cmdlet will start synchronization of objects with the organization cache database and upon synchronization completes, it returns data from the organization cache database. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, the cmdlet will return data directly from the organization. Default: PreferLocal	`VBOOrganizationDataSource`	False	Named	False
DisplayName	Specifies a display name of an organization group. The cmdlet will return organization groups with this display name.	`String`	False	Named	False
GroupName	Specifies a group name of an organization group. The cmdlet will return the organization group with this group name.	`String`	False	Named	False
Limit	Specifies the maximum number of groups that the cmdlet will return.	`UInt64`	False	Named	False
LocationFilter	Note: Use this parameter for organizations of the `Hybrid` type. Specifies an organization group location type: `Cloud` `OnPremises` `Hybrid` `CloudOrHybrid` `OnPremisesOrHybrid` `Any` The cmdlet will return organization groups of this location type.	`VBOLocationFilters`	False	Named	False
Name	Note: This parameter is deprecated. Use the `DisplayName` instead. Specifies a name of an organization group. The cmdlet will return organization groups with this name.	`String`	False	Named	False
NotInJob	Defines that the cmdlet will return groups that are not manually included in any of the backup jobs. Default: False Note: If a group is backed up by the `EntireOrganization` job, it also will be considered as not included in backups jobs.	`SwitchParameter`	False	Named	False
OfficeId	Specifies ID of a Microsoft 365 organization group. The cmdlet will return the organization group with this ID.	`Guid`	False	Named	False
OnPremisesId	Specifies ID of an on-premises organization group. The cmdlet will return the organization group with this ID.	`Guid`	False	Named	False
Organization	Specifies a Microsoft organization. The cmdlet will return organization groups of the specified organization. Accepts the `VBOOrganization` object. To get this object, run the `Get-VBOOrganization` cmdlet.	`VBOOrganization`	True	Named	True (ByValue)
Type	Specifies the organization group type: `Office 365` `Security` `Distribution` `DynamicDistribution` The cmdlet will return organization groups of this type. Note: The cmdlet will not return organization groups of an on-premises organization with SharePoint components.	`VBOOrganizationGroupType`	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 Learn.

Output Object

The cmdlet returns an array of the VBOOrganizationGroup objects that contain details about Microsoft Exchange and Microsoft SharePoint organization groups.

Examples

Get-VBOOrganizationGroup Example 1: Getting All Groups in Microsoft Organization

This example shows how to get all organization groups in the ABC organization.

$org = Get-VBOOrganization -Name "ABC"

Get-VBOOrganizationGroup -Organization $org

Perform the following steps:

Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name ABC. Save the result to the $org variable.
Run the Get-VBOOrganizationGroup cmdlet with the $org variable to get all organization groups of an organization with the name ABC.

Get-VBOOrganizationGroup Example 2: Getting Specific Group

This example shows how to get an organization group with the display name UsersAlpha from the ABC organization.

$org = Get-VBOOrganization -Name "ABC"

Get-VBOOrganizationGroup -Organization $org -DisplayName "UsersAlpha"

Perform the following steps:

Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name ABC. Save the result to the $org variable.
Run the Get-VBOOrganizationGroup cmdlet with the $org variable and the DisplayName parameter to get an organization group with the display name UsersAlpha.

Get-VBOOrganizationGroup Example 3: Getting Groups of Specific Type

This example shows how to get all organization groups with a display name starting with A of the Office365 type that are not manually included in any of backup jobs.

$org = Get-VBOOrganization -Name "ABC"

Get-VBOOrganizationGroup -Organization $org -DisplayName "A*" -Type Office365 -NotInJob

Perform the following steps:

Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name ABC. Save the result to the $org variable.
Run the Get-VBOOrganizationGroup cmdlet with the $org variable, the DisplayName parameter and the specified Type parameter to get an organization group of the Office365 type with a display name starting with A. Use the NotInJob parameter to get only organization groups that are not manually included in any of backup jobs.

Get-VBOOrganization