Remove-MsolGroupMember

Updated: July 30, 2015

Applies To: Azure, Office 365, Windows Intune

Note



  • The cmdlets were previously known as the Microsoft Online Services Module for Windows PowerShell cmdlets.

The Remove-MsolGroupMember cmdlet is used to remove a member from a security group. This member can be either a user or a group.

Syntax

Remove-MsolGroupMember -GroupObjectId <Guid> [-GroupMemberObjectId <Guid>] [-GroupMemberType <string>] [-TenantId <Guid>] [<CommonParameters>]

Parameters

    -GroupMemberObjectId <Guid>
        The object ID of the member (User or Group) to remove from the group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    -GroupMemberType <string>
        The type of member (User or Group) to remove from the group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    -GroupObjectId <Guid>
        The ID of the group to remove members from.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    -TenantId <Guid>
        The unique ID of the tenant to perform the operation on. If this is 
        not provided then the value will default to the tenant of the current 
        user. This parameter is only applicable to partner users.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer and OutVariable. For more information, type,
        "get-help about_commonparameters".

Examples

The following commands search for a group named "Marketing" and set that to the variable groupId. Then, they search for a user with user principal name (UPN) of CCole and set that to a variable of userId. Finally, the command removes CCole from Marketing utilizing the variables that were set.

$groupId = Get-MsolGroup -searchString "Marketing"

$userid = get-msoluser -userPrincipalName CCole@contoso.com

Remove-MsoLGroupMember -groupObjectId $groupid -GroupMemberType User -groupmemberobjectid $userid

Additional Resources

There are several other places you can get more information and help. These include:

See Also

Other Resources

Manage Azure Active Directory by using Windows PowerShell