Edit

Add-RdsAppGroupUser

  • Reference
Module:
WindowsVirtualDesktopPowershell

Assigns a user to access an app group.

Syntax

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

Description

The Add-RdsAppGroupUser cmdlet assigns a user to access the specified app group. This cmdlet only takes in a single user principal name (UPN) at a time and only applies to users (not groups). To add multiple users at a time, you can use loop PowerShell syntax. This cmdlet does not support groups as UPNs.

The UPN must exist in the Azure Active Directory associated with the tenant. If the user has already been assigned access to the app group, the cmdlet will succeed silently.

Examples

Example 1

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

This command adds the user to the list of users who can access the desktop application group.

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 assign access to an app group.

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

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtUser