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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-HostPoolName
The name of the host pool.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Id
The id for the specific role definition.
Parameter properties
Type:
Guid
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
RoleDefinitionIdParameterSet
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-RoleDefinitionName
The name of the role definition. Default role definition names include:
RDS Owner
RDS Reader
RDS Contributor
RDS Operator
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
EmptyParameterSet
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
RoleDefinitionNameParameterSet
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-TenantGroupName
The name of the tenant group.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-TenantName
The name of the tenant.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.