Get-RdsAppGroupUser

Reference

Module:: WindowsVirtualDesktopPowershell

Lists the users that have access to an app group.

Syntax

Get-RdsAppGroupUser
   [-TenantName] <String>
   [-HostPoolName] <String>
   [-AppGroupName] <String>
   [-UserPrincipalName <String>]
   [<CommonParameters>]

Description

The Get-RdsAppGroupUser cmdlet lists the users that have access to the specified app group. If you specify a user principal name, this cmdlet either returns the specified user principal name who has access to the app group or an error indicating that they do not have access.

Examples

Example 1: List all users who have been assigned to an app group

PS C:\> Get-RdsAppGroupUser -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "Desktop Application Group"

UserPrincipalName : user1@contoso.com
TenantName        : Contoso
TenantGroupName   : Default Tenant Group
HostPoolName      : contosoHostPool
AppGroupName      : Desktop Application Group

UserPrincipalName : user2@contoso.com
TenantName        : Contoso
TenantGroupName   : Default Tenant Group
HostPoolName      : contosoHostPool
AppGroupName      : Desktop Application Group

This command lists all users assigned to the specified app group.

Example 2: Check if a specific user has been assigned to an app group

PS C:\> Get-RdsAppGroupUser -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "Desktop Application Group" -UserPrincipalName "user1@contoso.com"

UserPrincipalName : user1@contoso.com
TenantName        : contoso
TenantGroupName   : Default Tenant Group
HostPoolName      : contosoHostPool
AppGroupName      : Desktop Application Group

This command lists the specified user if they have already been assigned to the app group. If the user has not been assigned to the app group, you will receive an error.

Parameters

-AppGroupName

The name of the app group.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-HostPoolName

The name of the host pool.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TenantName

The name of the tenant.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-UserPrincipalName

The user principal name (UPN) of the user you would like to check for app group access.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtUser