Remove-MceUser
SYNOPSIS
Updates the properties of an MCE user to set the user status to 'Removed'.
SYNTAX
Remove-MceUser [-Id] <String> [<CommonParameters>]
DESCRIPTION
This cmdlet marks a user on the system as 'Removed'.
The cmdlet is designed to support pipelining from Get-MceUser.
EXAMPLES
EXAMPLE 1
Remove-MceUser -Id "4f55b2be-1c07-4fcb-8c66-db563fd46206"
Removes the user with the specified Id. NOTE: Once a user is set to 'Removed', they cannot be set to other states; e.g. Attempting to set a 'Removed' user to 'Enabled' will result in an error. Get-MceUser -SearchTerm "aRemovedUserName" -IncludeRemovedUsers | Set-MceUser -Status Enabled
EXAMPLE 2
Get-MceUser -SearchTerm "john" | Remove-MceUser
Removes all users matching the name 'john'.
PARAMETERS
-Id
The user ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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.
INPUTS
System.String
The user ID.