Get-VBOOrganizationUser

Short Description

Returns organization users.

Syntax

This cmdlet provides the following parameter sets:

All (Default)

Get-VBOOrganizationUser -Organization <VBOOrganization> [-Limit <UInt64>] [-Type <VBOOrganizationUserType>]

[-NotInJob] [-LocationFilter <VBOLocationFilters>] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>]

ByName

Get-VBOOrganizationUser -Organization <VBOOrganization> [-Name <String>] [-UserName <String>]

[-DisplayName <String>] [-Limit <UInt64>] [-Type <VBOOrganizationUserType>] [-NotInJob]

[-LocationFilter <VBOLocationFilters>] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>]

ById

Get-VBOOrganizationUser -Organization <VBOOrganization> [-OfficeId <Guid>] [-OnPremisesId <Guid>]

[-Type <VBOOrganizationUserType>] [-NotInJob] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>]

Detailed Description

This cmdlet returns Microsoft organization users.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
DataSource	Specifies how the cmdlet will return organization users: `PreferLocal` For Microsoft organizations with modern app-only authentication, the cmdlet will return data from either the organization cache database if organization objects are already synchronized to this source, or directly from the organization if synchronization is in progress. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, the cmdlet will return data directly from the organization. `Production` The cmdlet will return data directly from the organization. `PreferLocalResynced` For Microsoft organizations with modern app-only authentication, the cmdlet will start synchronization of objects with the organization cache database and upon synchronization completes, it returns data from the organization cache database. For Microsoft organizations with modern authentication and legacy protocols or with basic authentication, the cmdlet will return data directly from the organization. Default: PreferLocal	`VBOOrganizationDataSource`	False	Named	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
Limit	Specifies the maximum number of users that the cmdlet will return.	`UInt64`	False	Named	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
Name	Note: This parameter is deprecated. Use the `UserName` or `DisplayName` parameter instead. Specifies a name of an organization user. The cmdlet will return the organization user with this name.	`String`	False	Named	False
NotInJob	Defines that the cmdlet will return users that are not manually included in any of the backup jobs. Default: False Note: If a user is backed up by the `EntireOrganization` job, it also will be considered as not included in backups jobs.	`SwitchParameter`	False	Named	False
OfficeId	Specifies an ID of a Microsoft 365 organization user. The cmdlet will return the organization user with this ID.	`Guid`	False	Named	False
OnPremisesId	Specifies an ID of an on-premises organization user. The cmdlet will return the organization user with this ID.	`Guid`	False	Named	False
Organization	Specifies a Microsoft organization. The cmdlet will return organization users of the specified organization. Accepts the `VBOOrganization` object. To get this object, run the `Get-VBOOrganization` cmdlet.	`VBOOrganization`	True	Named	True (ByValue)
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
UserName	Specifies a user name of an organization user. The cmdlet will return the organization user with this user name.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns an array of the VBOOrganizationUser objects that contain details about Microsoft organization users.

Examples

Get-VBOOrganizationUser Example 1: Getting All Users in Microsoft Organization