Get-VBOOrganizationUser

In this article

    Short Description

    Returns organization users.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get organization users of the specified type.

    Get-VBOOrganizationUser -Organization <VBOOrganization> [-Limit <uint64>] [-Type <VBOOrganizationUserType> {User | SharedMailbox | PublicMailbox}] [-NotInJob] [-LocationFilter {Cloud | OnPremises | Hybrid | CloudOrHybrid | OnPremisesOrHybrid | Any}] [<CommonParameters>]

    • Get organization users with a specific name.

    Get-VBOOrganizationUser -Organization <VBOOrganization> [-Name <string>] [-UserName <string>] [-DisplayName <string>] [-Limit <uint64>] [-Type <VBOOrganizationUserType> {User | SharedMailbox | PublicMailbox}] [-NotInJob] [-LocationFilter {Cloud | OnPremises | Hybrid | CloudOrHybrid | OnPremisesOrHybrid | Any}][<CommonParameters>]

    • Get organization users by ID.

    Get-VBOOrganizationUser -Organization <VBOOrganization> [-OfficeId <guid>] [-OnPremisesId <guid>] [-Type <VBOOrganizationUserType> {User | SharedMailbox | PublicMailbox}] [-NotInJob]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns Microsoft organization users.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Organization

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

    Accepts the VBOOrganization object.

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

    True

    Named

    True (ByValue)

    False

    UserName

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

    String

    False

    Named

    False

    False

    DisplayName

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

    String

    False

    Named

    False

    True

    Limit

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

    UInt64

    False

    Named

    False

    False

    Name

    Note: This parameter is obsolete.

    Specifies a name of an organization user. The cmdlet will return organization users with this name.

    String

    False

    Named

    False

    True

    NotInJob

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

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

    SwitchParameter

    False

    Named

    False

    False

    LocationFilter

    Note: Use this parameter for organizations of the Hybrid type.

    Specifies an organization user location type:

    • Cloud
    • OnPremises
    • Hybrid
    • CloudOrHybrid
    • OnPremisesOrHybrid
    • Any

    The cmdlet will return organization users of this location type.

    VBOLocationFilters

    False

    Named

    False

    False

    OfficeId

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

    Guid

    False

    Named

    False

    False

    OnPremisesId

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

    Guid

    False

    Named

    False

    False

    Type

    Specifies the organization user type:

    • User
    • SharedMailbox
    • PublicMailbox

    The cmdlet will return organization users of this type.

    Note: To get shared or public mailboxes in Microsoft organizations with modern app-only authentication, you must specify the User type. For more information, see this Veeam KB article.

    VBOOrganizationUserType

    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-VBOOrganizationUserExample 1. Getting All Users in Microsoft Organization

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

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -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-VBOrganizationUser cmdlet with the $org variable to get all organization users of an organization with the name ABC.

    Get-VBOOrganizationUserExample 2. Getting Users of Specific Type

    This example shows how to get all organization users of the User type in the ABC organization.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org -Type User

    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-VBOrganizationUser cmdlet with the $org variable to get all organization users of an organization with the name ABC. Use the Type parameter to select only the specified type of the organization users.

    Get-VBOOrganizationUserExample 3. Getting Specific User

    This example shows how to get the userAlpha organization user by the user display name.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org -DisplayName "userAlpha"

    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-VBOOrganizationUser cmdlet with the $org variable. Set the userAlpha value for the DisplayName parameter to get an organization user with the display name userAlpha.

    Get-VBOOrganizationUserExample 4. Getting Unprocessed Users Using Wildcards

    This example shows how to get all users of the User type with a name starting with A that are not specifically assigned to any backup job.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org -DisplayName "A*" -Type User -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-VBOOrganizationUser cmdlet with the $org variable. Set the A* value for the DisplayName parameter, the User value for the Type parameter to get all organization users of the User type with a name starting with A. Use the NotInJob parameter to get only organization users that are not specifically assigned to any backup job.

    Get-VBOOrganizationUserExample 5. Getting User by User Name

    This example shows how to get the userAlpha@tech.onmicrosoft.com organization user by the user name.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org -UserName "userAlpha@tech.onmicrosoft.com"

    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-VBOOrganizationUser cmdlet with the $org variable and the userAlpha@tech.onmicrosoft.com value for the UserName parameter.

    Related Commands

    Get-VBOOrganization