Get-RdsRoleDefinition
Lists all roles that are available for assignment.
Syntax
Get-RdsRoleDefinition
[-RoleDefinitionName <String>]
[-TenantGroupName <String>]
[-TenantName <String>]
[-HostPoolName <String>]
[-AppGroupName <String>]
[<CommonParameters>]
Get-RdsRoleDefinition
[-RoleDefinitionName <String>]
[-TenantGroupName <String>]
[-TenantName <String>]
[-HostPoolName <String>]
[-AppGroupName <String>]
[<CommonParameters>]
Get-RdsRoleDefinition
-Id <Guid>
[-TenantGroupName <String>]
[-TenantName <String>]
[-HostPoolName <String>]
[-AppGroupName <String>]
[<CommonParameters>]
Description
The Get-RdsRoleDefinition cmdlet lists all roles that are available for assignment. You can look at a specific role by providing the name or the id of the role definition. Currently, custom roles are not supported.
Examples
Example 1: List all available roles
PS C:\> Get-RdsRoleDefinition
RoleDefinitionName : RDS Owner
Id : 3b14baea-8d82-4610-f5da-08d623dd1cc4
Scope : /
IsCustom : False
Description : Can perform all operations on any RDS objects.
Actions : {*}
AssignableScopes : {}
Item :
RoleDefinitionName : RDS Reader
Id : 2ea11dc0-46e3-4ee8-f5db-08d623dd1cc4
Scope : /
IsCustom : False
Description : Can Read properties of RDS objects
Actions : {*/Read}
AssignableScopes : {}
Item :
RoleDefinitionName : RDS Contributor
Id : f5dc85e1-b94d-48f0-f5dc-08d623dd1cc4
Scope : /
IsCustom : False
Description : Can perform all operations on any RDS object, except role assignment
Actions : {Microsoft.RDS.Resources/*, Microsoft.RDS.Diagnostics/*}
AssignableScopes : {}
Item :
RoleDefinitionName : RDS Operator
Id : 827a079d-aa89-4d0d-f5dd-08d623dd1cc4
Scope : /
IsCustom : False
Description : Can Read diagnostics information.
Actions : {Microsoft.RDS.Diagnostics/Read}
AssignableScopes : {}
Item :
This command lists all available roles that can be assigned.
Parameters
-AppGroupName
The name of the app group.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-HostPoolName
The name of the host pool.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
The id for the specific role definition.
Type: | Guid |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RoleDefinitionName
The name of the role definition. Default role definition names include:
- RDS Owner
- RDS Reader
- RDS Contributor
- RDS Operator
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantGroupName
The name of the tenant group.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantName
The name of the tenant.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
System.String
System.Guid
Outputs
System.Object