Get-VBOOrganizationUser
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>] [-NotInJob] [-LocationFilter <VBOLocationFilters>] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>] |
- Get organization users by name.
Get-VBOOrganizationUser -Organization <VBOOrganization> [-Name <String>] [-UserName <String>] [-DisplayName <String>] [-Limit <UInt64>] [-Type <VBOOrganizationUserType>] [-NotInJob] [-LocationFilter <VBOLocationFilters>] [-DataSource <VBOOrganizationDataSource>] [<CommonParameters>] |
- Get organization users by ID.
Get-VBOOrganizationUser -Organization <VBOOrganization> [-OfficeId <Guid>] [-OnPremisesId <Guid>] [-Type <VBOOrganizationUserType>] [-NotInJob] [-DataSource <VBOOrganizationDataSource>][<CommonParameters>] |
Detailed Description
This cmdlet returns Microsoft organization users.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
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. | True | Named | True (ByValue) |
Limit | Specifies the maximum number of users that the cmdlet will return. | UInt64 | False | Named | False |
Type | Specifies the organization user type:
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 |
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 |
LocationFilter | Note: Use this parameter for organizations of the Hybrid type. Specifies an organization user location type:
The cmdlet will return organization users of this location type. | VBOLocationFilters | False | Named | False |
DataSource | Specifies how the cmdlet will return organization users:
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.
The cmdlet will return data directly from the organization.
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 |
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 |
UserName | Specifies a user name of an organization user. The cmdlet will return the organization user with this user name. | String | 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 |
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 |
<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. Getting All Users in Microsoft Organization
This example shows how to get all organization users in the ABC organization.
Perform the following steps:
|
Example 2. Getting Users of Specific Type
This example shows how to get all organization users of the User type in the ABC organization.
Perform the following steps:
|
Example 3. Getting Specific User
This example shows how to get the userAlpha organization user by the user display name.
Perform the following steps:
|
Example 4. Getting Unprocessed Users Using Wildcards
This example shows how to get all users of the User type with a display name starting with A that are not manually included in any of backup jobs.
Perform the following steps:
|
Example 5. Getting User by User Name
This example shows how to get the userAlpha@tech.onmicrosoft.com organization user by the user name.
Perform the following steps:
|
Related Commands