Set-TSTMGMTUserAssignment

Updates a User Assignment's details within the Management Platform.

Written by Ines

Last published at: December 14th, 2022

Updates a User Assignment's details within the Management Platform.

SYNTAX

Set-TSTMGMTUserAssignment

-UserAssignment <UserAssignment> [-UserAssignmentName <string>] [-Description <string>] [-AddGroupMembers <string[]>] [-RemoveGroupMembers <string[]>] [-RemoveAllGroupMembers] [-Interface <guid>] [-Timeout <int>]

 

 

DESCRIPTION

Updates properties of an existing User Assignment in the Management Platform.

 

EXAMPLE

Remove All group members from the User Assignment called ‘Support’
 

        Get-TSTMGMTUserAssignment -UserAssignmentName '\User Assignments\Support' | Set-TSTMGMTUserAssignment -RemoveAllGroupMembers

 

PARAMETERS

 

-UserAssignmentName

Fully qualified or relative name of the user assignment to create

Type: String
Required: Yes
Accept Pipeline Input: No

 

-Description

New description for the User Assignment

Type: String
Required: Yes
Accept Pipeline Input: No

 

-AddGroupMembers

Comma delimited list of group members to add to the User Assignment

Type: String
Required: No
Accept Pipeline Input: No

 

-RemoveGroupMembers

Comma delimited list of group members to remove from the User Assignment.

Type: String
Required: No
Accept Pipeline Input: No

 

-RemoveAllGroupMembers

Removes all group members from the User Assignment.

Type: SwitchParameter
Required: No
Accept Pipeline Input: No

 

-Interface

The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.

Type: Guid
Required: No
Accept Pipeline Input: No

 

-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

Type: Int32
Required: No
Accept Pipeline Input: No

 

INPUTS

ThinScale.Management.DataObjects.UserAssignment

 

OUTPUTS

ThinScale.Management.DataObjects.UserAssignment