New-VBORbacRoleItem

Short Description

Defines Microsoft 365 organization users, groups, sites or teams that will be managed by restore operators or excluded.

Syntax

This cmdlet provides the following parameter sets:

UserParameterSet

New-VBORbacRoleItem -User <VBOOrganizationUser[]> [<CommonParameters>]
SiteParameterSet

New-VBORbacRoleItem -Site <VBOOrganizationSite[]> [<CommonParameters>]
GroupParameterSet

New-VBORbacRoleItem -Group <VBOOrganizationGroup[]> [<CommonParameters>]
TeamParameterSet

New-VBORbacRoleItem -Team <VBOOrganizationTeam[]> [<CommonParameters>]
PersonalSitesParameterSet

New-VBORbacRoleItem [-PersonalSites] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBORbacRoleItem object. This object contains specific users, groups, sites, or teams. Restore operators will be allowed/not allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for this object.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Group	Specifies an array of groups added to Veeam Backup for Microsoft 365. The cmdlet will define these groups as objects to manage/exclude. Accepts the `VBOOrganizationGroup[]` object. To get this object, run the `Get-VBOOrganizationGroup` cmdlet.	`VBOOrganizationGroup[]`	True	Named	False
PersonalSites	Defines that the cmdlet will define personal sites as objects to manage/exclude. Default: False	`SwitchParameter`	True	Named	False
Site	Specifies an array of SharePoint sites added to Veeam Backup for Microsoft 365. The cmdlet will define these sites as objects to manage/exclude. Accepts the `VBOOrganizationSite[]` object. To get this object, run the `Get-VBOOrganizationSite` cmdlet.	`VBOOrganizationSite[]`	True	Named	False
Team	Specifies an array of teams added to Veeam Backup for Microsoft 365. The cmdlet will define these teams as objects to manage/exclude. Accepts the `VBOOrganizationTeam[]` object. To get this object, run the `Get-VBOOrganizationTeam` cmdlet.	`VBOOrganizationTeam[]`	True	Named	False
User	Specifies an array of users added to Veeam Backup for Microsoft 365. The cmdlet will define these users as objects to manage/exclude. Accepts the `VBOOrganizationUser[]` object. To get this object, run the `Get-VBOOrganizationUser` cmdlet.	`VBOOrganizationUser[]`	True	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

This cmdlet returns the VBORbacRoleItem object that contains details on users, groups, or sites that will be managed by restore operators or excluded.

Examples

Defining User as Object to Manage/Exclude

This example shows how to define the JohnDoe organization user as an object to manage/exclude.

$org = Get-VBOOrganization -Name "ABC"

$User = Get-VBOOrganizationUser -Organization $org -DisplayName "JohnDoe"

New-VBORbacRoleItem -User $User

Perform the following steps:

Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name ABC. Save the result to the $org variable.
Run the Get-VBOOrganizationUser cmdlet with the $org variable and the JohnDoe value for the DisplayName parameter. Save the result to the $User variable.
Run the New-VBORbacRoleItem cmdlet. Set the $User variable as the User parameter value.