Update-SCSMUserRole
Update-SCSMUserRole
Sets the UserRole property for a Service Manager user.
Syntax
Parameter Set: Default
Update-SCSMUserRole [-UserRole] <Role[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Update-SCSMUserRole cmdlet sets the UserRole property for a Service Manager user.
Parameters
-PassThru
Specifies the output object that represents the updated user role. This output object can be passed to other cmdlets.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserRole<Role[]>
Specifies the UserRole object to which to add the user.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.EnterpriseManagement.ServiceManager.Sdk.UserRoles.Role
You can pipe a UserRole object to the UserRole parameter of the Update-SCSMUserRole cmdlet. For example, the object that is returned by the Get-SCSMUserRole cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
None.
This cmdlet does not generate any output.
Examples
-------------------------- EXAMPLE 1 --------------------------
The commands in this example add User to the set of Read-Only OperatorsDescription.
PS C:\>$Role = Get-SCSMUserRole IncidentResolvers
PS C:\>$User = Get-SCSMUser -username Joe
PS C:\>$Role.User += $User
PS C:\>$Role | Update-SCSMUserRole
-------------------------- EXAMPLE 2 --------------------------
The commands in this example remove a user from a user role.
PS C:\>$Role = Get-SCSMUserRole Administrators
PS C:\>$Role.User
PS C:\>$Role.User = $Role.Users[0]