Remove-LinaUser

NAME Remove-LinaUser



SYNOPSIS

Deletes a User from a Lina Server.





SYNTAX

Remove-LinaUser -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]



Remove-LinaUser -LinaObjects <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]





DESCRIPTION

Deletes a User.





PARAMETERS

-LinaObjects <PSObject[]>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

Name of the User(s) to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on

multiple users).

Note : Be careful, multiple Users can have the same name in different tenants.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

No actual deletion will happen if set. It will only display what User(s) would be deleted.

Sometimes also called "Dry Run mode"



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Bulk [<SwitchParameter>]

Security parameter to enable deletion of multiple Users. If not set only one User will be deleted.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Accept pipelining of LinaUser objects (from Get-LinaUser for example)





OUTPUTS

None





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Remove-LinaUser -Name "MyUser"



Real deletion of a single User by name









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-LinaUser -Name "MyUser" | Remove-LinaUser



Same example as #1 but using piped commands









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-LinaUser -Name "MyUser*" | Remove-LinaUser -Bulk -WhatIf



Simulates deletion of a multiple Users by name (WhatIf mode)









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-LinaUser -Name "MyUser*" | Remove-LinaUser -Bulk



Real deletion of a multiple Users by name.











RELATED LINKS