Get-VBOOrganizationGroup

In this article

    Short Description

    Returns organization groups.

    Syntax

    This cmdlet provides the following parameter sets:

    • Get organization groups.

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Limit <uint64>] [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob]  [<CommonParameters>]

    • Return organization groups by name.

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Name <string>] [-DisplayName <string>] [-GroupName <string>] [-Limit <uint64>] [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob]  [<CommonParameters>]

    • Return organization groups by ID.

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-OfficeId <guid>] [-OnPremisesId <guid>] [-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 Pipeline Input

    Accept Wildcard Characters

    Organization

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

    True

    Named

    True (ByValue)

    False

    DisplayName

    Specifies the display name of the organization group. This cmdlet returns organization groups with this display name.

    False

    Named

    False

    False

    GroupName

    Specifies a group name of an organization group. The cmdlet will return the organization group with this group name.

    False

    Named

    False

    False

    Name

    Note: This parameter is obsolete.

    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

    Limit

    Specifies the maximum number of groups that the cmdlet will return.

    False

    Named

    False

    False

    OfficeId

    Specifies ID of a Microsoft Office 365 organization group. This cmdlet returns the organization group with this ID.

    False

    Named

    False

    False

    OnPremisesId

    Specifies ID of an on-premises organization group. This cmdlet returns the organization group with this ID.

    False

    Named

    False

    False

    Type

    Specifies the type of the organization group:

    • Office 365
    • Security
    • Distribution
    • DynamicDistribution

    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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

    Example 1

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

    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-VBOrganizationGroup cmdlet with the $org variable to get all organization groups of an organization with the name "ABC".

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationGroup -Organization $org

    Example 2

    This example shows how to get an organization group with the name "UsersAlpha" from the "ABC" organization:

    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-VBOrganizationGroup cmdlet with the $org variable and the Name parameter to get an organization group with the name "UsersAlpha".

    $org = Get-VBOOrganization -Name "ABC"

    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.

    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-VBOrganizationGroup cmdlet with the $org variable, the 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.

    $org = Get-VBOOrganization -Name "ABC"

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

    Related Commands

    Get-VBOOrganization