Remove-TeamChannelUser
Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update.
To turn an existing Owner into a Member, specify role parameter as Owner.
Note: last owner cannot be removed from the private channel.
Syntax
Remove-TeamChannelUser
-GroupId <String>
-DisplayName <String>
-User <String>
[-Role <String>]
[<CommonParameters>]
Description
Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see Install Teams PowerShell public preview and also see Microsoft Teams PowerShell Release Notes.
Examples
Example 1
Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User [email protected]
Parameters
-DisplayName
Display name of the private channel
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-GroupId
GroupId of the team
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Role
Use this to demote a user from owner to member of the team
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-User
User's UPN (user principal name - e.g. [email protected])
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |