Remove-RdsAppGroupUser

Reference

Module:: WindowsVirtualDesktopPowershell

Removes a user's access to an app group.

Syntax

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

Description

The Remove-RdsAppGroupUser cmdlet removes a user's access to 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 remove 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 not already been assigned access to the app group, the cmdlet will succeed silently.

Examples

Example 1

PS C:\> Remove-RdsAppGroupUser -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "officeApps" -UserPrincipalName "user1@contoso.com"

This command removes the user's access to the app 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 whose app group access you would like to remove.

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

Share via