Remove-LocalUser
Deletes local user accounts.
Syntax
Remove-LocalUser
[-InputObject] <LocalUser[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-LocalUser
[-Name] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-LocalUser
[-SID] <SecurityIdentifier[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-LocalUser cmdlet deletes local user accounts.
Examples
Example 1: Delete a user account
PS C:\> Remove-LocalUser -Name "AdminContoso02"
This command deletes the user account named AdminContoso02.
Note
The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit system.
Parameters
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies an array of user accounts that this cmdlet deletes. To obtain a user account, use the Get-LocalUser cmdlet.
Type: | Microsoft.PowerShell.Commands.LocalUser[] |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies an array of names of the user accounts that this cmdlet deletes.
Type: | String[] |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies an array of security IDs (SIDs) of user accounts that this cmdlet deletes.
Type: | SecurityIdentifier[] |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
System.Management.Automation.SecurityAccountsManager.LocalUser, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local user, a string, or a SID to this cmdlet.
Outputs
None
This cmdlet does not generate any output.
Notes
- The PrincipalSource property is a property on LocalUser, LocalGroup, and LocalPrincipal objects that describes the source of the object. The possible sources are as follows:
- Local
- Active Directory
- Azure Active Directory group
- Microsoft Account
PrincipalSource is supported only by Windows 10, Windows Server 2016, and later versions of the Windows operating system. For earlier versions, the property is blank.