Skip to content

Remove-WETUser

SYNOPSIS

Remove a user from the WET system.

SYNTAX

Remove-WETUser [-Id] <Int32> [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function removes a user from the WET system by specifying the user's ID. Optionally, credentials can be provided for authentication. The function supports confirmation prompts and "WhatIf" scenarios for safe execution.

EXAMPLES

EXAMPLE 1

Remove-WETUser -Id 123

Removes the user with ID 123 from the WET system.

EXAMPLE 2

Remove-WETUser -Id 123 -Credential (Get-Credential)

Removes the user with ID 123 from the WET system using the specified credentials.

EXAMPLE 3

Remove-WETUser -Id 123 -WhatIf

Simulates the removal of the user with ID 123 without making any changes.

PARAMETERS

-Id

The ID of the user to be removed.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Credential

The PSCredential object to use for authentication. If not provided, default credentials will be used.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
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: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Required: False
Position: Named
Default value: None
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.

INPUTS

OUTPUTS

NOTES