Get-TSTMGMTUserAssignment

List details of one User Assignment

Written by Ines

Last published at: December 14th, 2022

List details of one User Assignment

 SYNTAX

Delete

Get-TSTMGMTUserAssignment

[-UserAssignmentName <string>] [-UserAssignmentId <guid>] [-Force] [-Interface <guid>] [-Timeout <int>]

 

 DESCRIPTION

List details of a single User Assignment that contains profile details, packages assigned and members. If several or all user assignments are required, please use Get-TSTMGMTUserAssignments. Either -UserAssignmentName or -UserAssignmentId are required parameters.

EXAMPLES

Retrieve UserAssignment based on -UserAssignmentName which is the fully qualified name of the User Assignment.

Get-TSTMGMTUserAssignment -UserAssignmentName '\User Assignments\MyUA'

 

 

PARAMETERS

-Folder

Folder object to get User Assignments from

Type: ThinScale.Management.DataObjects.Folder
Required: No
Accept Pipeline Input: Yes

 

-FolderName

A fully qualified name of the folder to get User Assignments from

Type: String
Required: No
Accept Pipeline Input: No

 

-FolderId

The GUID of the folder to get User Assignments from (not required if FolderName is supplied)

Type: Guid
 
Required: No
Accept Pipeline Input: No

 

-Force

If multiple objects are found with the same name, the first retrieved will be used otherwise the call will fail

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.Folder

 

OUTPUTS

ThinScale.Management.DataObjects.UserAssignment