Set-VBORbacRole
Short Description
Modifies settings of restore operator roles that are added to Veeam Backup for Microsoft 365.
Syntax
This cmdlet provides parameter sets that allow you to:
- Modify settings of the restore operator role that allows you to manage selected objects.
Set-VBORbacRole -Role <VBOOperatorRole> [-Name <String>] [-Description <String>] [-Operators <VBORbacOperator[]>] [-SelectedItems <VBORbacRoleItem[]>] [-ExcludedItems <VBORbacRoleItem[]>] [<CommonParameters>] |
- Modify settings of the restore operator role that allows you to manage entire organization.
Set-VBORbacRole -Role <VBOOperatorRole> [-Name <String>] [-Description <String>] [-Operators <VBORbacOperator[]>] [-EntireOrganization] [-ExcludedItems <VBORbacRoleItem[]>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of the specified restore operator role. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Role | Specifies a restore operator role. The cmdlet will modify settings of this restore operator role. | Accepts the VBOOperatorRole object. To get this object, run the Get-VBORbacRole cmdlet. | True | Named | True (ByValue) |
Name | Specifies a restore operator role name. The cmdlet will replace the current name with the specified name. | String | False | Named | False |
Description | Specifies a description of the restore operator role. The cmdlet will replace the current description with the specified description. | String | False | Named | False |
Operators | Specifies an array of restore operators. The cmdlet will replace the current restore operators with the specified restore operators. | Accepts the VBORbacOperator[] object. To create this object, run the New-VBORbacOperator cmdlet. | False | Named | False |
SelectedItems | Specifies an array of objects to manage. The cmdlet will replace the current objects to manage with the specified ones. | Accepts the VBORbacRoleItem[] object. To create this object, run the New-VBORbacRoleItem cmdlet. | False | Named | False |
ExcludedItems | Specifies an array of objects to exclude. The cmdlet will replace the current objects to exclude with the specified ones. Note: You cannot exclude objects that have been specified for the SelectedItems parameter. | Accepts the VBORbacRoleItem[] object. To create this object, run the New-VBORbacRoleItem cmdlet. | False | Named | False |
EntireOrganization | Defines that the specified restore operators will be able to explore and restore all objects within the specified Microsoft 365 organization. Default: False | SwitchParameter | 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.
Output Object
The cmdlet returns the VBORbacRole object that contains the restore operator role settings.
Example
Modifying Restore Operators List
This example shows how to change a list of restore operators added to the specified restore operator role.
$org = Get-VBOOrganization -Name "ABC" $role = Get-VBORbacRole -Name "ABC Restore Operators" $User = Get-VBOOrganizationUser -Organization $org -UserName "userAlpha@tech.onmicrosoft.com" $newrestoreoperator = New-VBORbacOperator -User $User Set-VBORbacRole -Role $role -Operators $newrestoreoperator |
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-VBORbacRole cmdlet with the Name parameter to get the restore operator role whose settings you want to modify. Save the result to the $role variable.
- Run the Get-VBOOrganizationUser cmdlet with the $org variable and the userAlpha@tech.onmicrosoft.com value for the UserName parameter to get an organization user with the name userAlpha. Save the result to the $User variable.
- Run the New-VBORbacOperator cmdlet. Set the $User variable as the User parameter value. Save the result to the $newrestoreoperator variable.
- Run the Set-VBORbacRole cmdlet. Set the $role variable as the Role parameter value and the $newrestoreoperator variable as the Operators parameter value.
Related Commands