Get User Role
Important
This version of Orchestrator has reached the end of support. We recommend you to upgrade to Orchestrator 2022.
Returns data on all the user roles within the VMM server.
Important
When designating a computer, you must specify it using the FQDN. FQDN names are case sensitive.
Get User Role Required Properties
None
Get User Role Optional Properties
None
Get User Role Filters
| Element | Description | Valid Values |
|---|---|---|
| Actions Permitted | The actions that members of a Self-Service User role can perform on their virtual machines or services. | AllowLocalAdmin, Author, CanShare, CanReceive, Checkpoint,CheckpointRestoreOnly, Create, CreateFromVHDOrTemplate, PauseAndResume, RemoteConnect, Remove, Save, Shutdown, Start, Stop, Store. |
| Cloud Names in Scope | The cloud scope of a user role. | |
| Host Group Names in Scope | The host scope of a user role (not for Self-Service User Role). | |
| Description | An alphanumeric description of the user role. | |
| Library Server Names | The library server that the user role can use. (not for Self-Service User Role) | |
| Member Names | Members of a user role. | |
| Profile Type | The type of VMM user role. | Administrator, SelfServiceUser, ReadOnlyAdmin, DelegatedAdmin |
| User Role data Path | The library path that each member of this user role can upload their data to | \\MyLibraryServer.CONTOSO.com\OneUserRoleVMMLibrary |
| Most Recent | True or False. | |
| User Role ID | The unique identifier (GUID) of the user role. | |
| User Role Name | The names of the user role. | |
| Application Profile Resource Names | ||
| Guest OS Profile Resource Names | ||
| Hardware Profile Resource Names | ||
| Service Configuration Resource Names | ||
| Service Instance Resource Names | ||
| Service Template Resource Names | ||
| SQL Profile Resource Names | ||
| VM Instance Resource Names | ||
| VM template Resource Names |
Get User RolePublished Data
| Element | Description |
|---|---|
| User Role ID | The ID of the user role. |
| User Role Name | The name of the user role. |
| Profile Type | The profile type of the user role. |
| Host Group Names in Scope | |
| Cloud Names in Scope | |
| Actions Permitted | List of actions permitted. |
| Member Names | Members of the user role. |
| Description | Text description of the user role. |
| User Role Data Path | |
| Library Server Names | |
| VM Template Resource Names | |
| Service Template Resource Names | |
| Service Instance Resource Names | |
| VM Instance Resource Names | |
| Hardware Profile Resource Names | |
| Application Profile Resource Names | |
| Guest OS Profile Resource Names | |
| SQL Profile Resource Names | |
| Service Configuration Resource Names |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for