Table of contents
ISE
TOC
Collapse the table of content
Expand the table of content

Remove-LocalUser

JuanPablo Jofre|Last Updated: 12/17/2016
|
3 Contributors

SYNOPSIS

Deletes local user accounts.

SYNTAX

InputObject

Remove-LocalUser [-InputObject] <LocalUser[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Default

Remove-LocalUser [-Name] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

SecurityIdentifier

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.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies an array of user accounts that this cmdlet deletes. To obtain a user account, use the Get-LocalUser cmdlet.

Type: LocalUser[]
Parameter Sets: InputObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

Specifies an array of names of the user accounts that this cmdlet deletes.

Type: String[]
Parameter Sets: Default
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SID

Specifies an array of security IDs (SIDs) of user accounts that this cmdlet deletes.

Type: SecurityIdentifier[]
Parameter Sets: SecurityIdentifier
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

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.

Disable-LocalUser

Enable-LocalUser

Get-LocalUser

New-LocalUser

Rename-LocalUser

Set-LocalUser

© 2017 Microsoft