The Get-RdsRoleAssignment cmdlet lists all role assignments at the defined scope. Without any parameters, this command returns all the role assignments starting at the highest scope authorized to the current user. To define the scope, you can use a combination of the following parameters:
TenantGroupName
TenantName
HostPoolName
AppGroupName
This list can be also be filtered by specifying the principal of the role assignment. To specify the principal, you can use one of the following parameters:
This command gets all role assignments for the specified service principal in the current context. You must provide the application ID of the service principal as the value of the parameter.
Example 4: List role assignments for an Azure AD group
This command gets all role assignments for the specified Azure AD group in the current context.
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
-Deployment
A scope specific to Windows Virtual Desktop.
Parameter properties
Type:
Switch
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
-GroupObjectId
The object ID of the Azure AD group to filter for role assignments.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
UserGroupObjectId
Parameter sets
GroupObjectIdParameterSet
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
-ServicePrincipalName
The application ID of the service principal to filter for role assignments.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
SPN, ApplicationId
Parameter sets
ServicePrincipalParameterSet
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-SignInName
The user principal name (UPN) of the user to filter for role assignments.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Email, UserPrincipalName
Parameter sets
EmptyParameterSet
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
SignInNameParameterSet
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.