Get-VBOOrganizationGroup

In this article

    Short Description

    Returns organization groups.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get organization groups.

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Limit <uint64>] [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob] [-LocationFilter {Cloud | OnPremises | Hybrid | CloudOrHybrid | OnPremisesOrHybrid | Any}]  [<CommonParameters>]

    • Get organization groups by name.

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Name <string>] [-DisplayName <string>] [-GroupName <string>] [-Limit <uint64>] [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob] [-LocationFilter {Cloud | OnPremises | Hybrid | CloudOrHybrid | OnPremisesOrHybrid | Any}]  [<CommonParameters>]

    • Get 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 Microsoft Exchange and Microsoft SharePoint organization groups.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Organization

    Specifies an organization. The cmdlet will return organization groups of the specified organization.

    Accepts the VBOOrganization object.

    To get this object, run the Get-VBOOrganization cmdlet.

    True

    Named

    True (ByValue)

    False

    DisplayName

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

    String

    False

    Named

    False

    True

    GroupName

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

    String

    False

    Named

    False

    False

    Name

    Note: This parameter is obsolete.

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

    String

    False

    Named

    False

    True

    NotInJob

    Defines that the cmdlet will return groups that are not assigned to any of the backup jobs.

    Note: Groups that are backed up by the EntireOrganization job are considered to be NotInJob as well.

    SwitchParameter

    False

    Named

    False

    False

    Limit

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

    UInt64

    False

    Named

    False

    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

    False

    OfficeId

    Specifies ID of a Microsoft 365 organization group. The cmdlet will return the organization group with this ID.

    Guid

    False

    Named

    False

    False

    OnPremisesId

    Specifies ID of an on-premises organization group. The cmdlet will return the organization group with this ID.

    Guid

    False

    Named

    False

    False

    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

    False

    <CommonParameters>

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

    Examples

    Get-VBOOrganizationGroupExample 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:

    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.

    Get-VBOOrganizationGroupExample 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:

    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 DisplayName parameter to get an organization group with the display name UsersAlpha.

    Get-VBOOrganizationGroupExample 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 specifically assigned to any backup job.

    $org = Get-VBOOrganization -Name "ABC"

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

    Perform the following steps:

    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 DisplayName parameter and a specified Type parameter to get an organization group of the Office365 type with a display name starting with A. Use NotInJob parameter to get only organization groups that are not specifically assigned to any backup job.

    Related Commands

    Get-VBOOrganization