Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Get-VBOOrganizationUser

Short Description

Returns organization users.

Syntax

This cmdlet provides 2 parameter sets.

  • For getting all organization users of the specified type:

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

  • For getting 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

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

Organization

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

True

Named

True (ByValue)

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

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

  1. Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
  2. Run Get-VBOrganizationUser with the $org variable to get all organization users of an organization with a name "ABC".

PS C:\PS> $org = Get-VBOOrganization -Name "ABC"

PS C:\PS> 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 Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
  2. 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.

PS C:\PS> $org = Get-VBOOrganization -Name "ABC"

PS C:\PS> Get-VBOOrganizationUser -Organization $org -Type User

Example 3

This example shows how to get an organization user with a name "UserAlpha":

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

PS C:\PS> $org = Get-VBOOrganization -Name "ABC"

PS C:\PS> 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:

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

PS C:\PS> $org = Get-VBOOrganization -Name "ABC"

PS C:\PS> Get-VBOOrganizationUser -Organization $org -Name "A*" -Type User -NotInJob

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference