This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBOOrganizationUser

In this article

Short Description

Returns organization users.

Syntax

This cmdlet provides the following parameter sets.

Get all organization users of the specified type

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

Get an organization user with a specific name

Get-VBOOrganizationUser -Organization <VBOOrganization> [-Name <string>] [-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
Name	Specifies an organization user name. This cmdlet will return an organization user with this name.	False	Named	False	False
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
Type	Specifies organization user type: User Shared Mailbox Public Mailbox This cmdlet will return an organization user with this type.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

This example shows how to get all organization users for an organization with a name "ABC":

Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
Run Get-VBOrganizationUser with the $org variable to get all organization users of an organization with a 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:

Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
Run Get-VBOrganizationUser with the $org variable to get all organization users of an organization with a name "ABC". Use 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 an organization user with a name "UserAlpha":

Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
Run Get-VBOOrganizationUser with the $org variable and the "UserAlpha" value for the Name parameter to get an organization user with a name "UserAlpha".

$org = Get-VBOOrganization -Name "ABC"

Get-VBOOrganizationUser -Organization $org -Name "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:

Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
Run Get-VBOOrganizationUser with the $org variable, the "A*" value for the Name parameter, the User value for the Type parameter to get all organization users of a user type with a name starting with "A". Use 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 -Name "A*" -Type User -NotInJob

Related Commands

Get-VBOOrganization