Remove-MsolUser

Article
12/08/2015

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-MsolUser cmdlet is used to remove a user from the . This cmdlet will delete the user, their licenses, and any other associated data.

Syntax

Remove-MsolUser -UserPrincipalName <string> [-RemoveFromRecycleBin <switch>] [-Force] [-TenantId <Guid>] [<CommonParameters>]

Parameters

    -Force [<SwitchParameter>]
        Used to bypass onscreen confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ObjectId <Guid>
        The object ID of the user to remove.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    -RemoveFromRecycleBin <switch>
        Permanently removes the user from Azure AD recycle bin. 
        
        Required?                    false
        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
        
    -UserPrincipalName <string>
        The user ID of the user to remove.
        
        Required?                    true
        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 examples show the use of this cmdlet.

Example 1

This command removes user@contoso.com from the . If the user has any licenses these will be removed as well. A confirmation prompt is shown, so that you can confirm the operation.

Remove-MsolUser -UserPrincipalName user@contoso.com

Example 2

This command removes CCole@contoso.com from the . If the user has any licenses these will be removed as well.

Remove-MsolUser -UserPrincipalName CCole@contoso.com -force

Example 3

This command removes CCole@contoso.com from the recycle bin. A confirmation prompt will be output to the screen to confirm the operation. This command will permanently remove the user with no opportunity to recover the user.

Remove-MsolUser -UserPrincipalName CCole@contoso.com -RemoveFromRecycleBin

Additional Resources

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

Share via