Get-VBOOrganizationUser

In this article

    Short Description

    Returns organization users.

    Syntax

    This cmdlet provides the following parameter sets:

    • Get organization users of the specified type.

    Get-VBOOrganizationUser -Organization <VBOOrganization> [-Limit <uint64>] [-Type <VBOOrganizationUserType> {User | SharedMailbox | PublicMailbox}] [-NotInJob]  [<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] [<CommonParameters>]

    • Get organization users by ID.

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

    Detailed Description

    This cmdlet returns organization users.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Organization

    Specifies an organization. This cmdlet will return organization users of a specified organization.

    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.

    False

    Named

    False

    False

    DisplayName

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

    False

    Named

    False

    True

    Limit

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

    False

    Named

    False

    False

    Name

    Note: This parameter is obsolete.

    Specifies an organization user name. This cmdlet will return an organization user with this name.

    False

    Named

    False

    True

    NotInJob

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

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

    False

    Named

    False

    True

    OfficeId

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

    False

    Named

    False

    False

    OnPremisesId

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

    False

    Named

    False

    False

    Type

    Specifies organization user type:

    • User
    • Shared Mailbox
    • Public Mailbox

    This cmdlet will return an organization user with this type.

    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 users for an organization with the name "ABC":

    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".

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org

    Example 2

    This example shows how to get all organization users of the User type 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-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.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org -Type User

    Example 3

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

    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" value for the DisplayName parameter to get an organization user with the name "UserAlpha".

    $org = Get-VBOOrganization -Name "ABC"

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

    Example 4

    This example shows how to get all users of a User type with a name starting with "A" and 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-VBOOrganizationUser cmdlet with the $org variable, the "A*" value for the DisplayName parameter, the User value for the Type parameter to get all organization users of a 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.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationUser -Organization $org -DisplayName "A*" -Type User -NotInJob

    Example 5

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

    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 to get an organization user with the name "UserAlpha".

    $org = Get-VBOOrganization -Name "ABC"

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

    Related Commands

    Get-VBOOrganization