< Back
Remove-LinaUserGroup
Post
NAME Remove-LinaUserGroup
SYNOPSIS
Deletes a User Group from a Lina Server.
SYNTAX
Remove-LinaUserGroup -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]
Remove-LinaUserGroup -LinaObjects <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]
DESCRIPTION
Deletes a User Group.
PARAMETERS
-LinaObjects <PSObject[]>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String>
Name of the User Group(s) to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on
multiple groups).
Note : Be careful, multiple User Profiles 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 Group(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 User Groups. If not set only one User Group 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 LinaUserGroup objects (from Get-LinaUserGroup for example)
OUTPUTS
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-LinaUserGroup -Name "MyUserGroup"
Real deletion of a single User Group by name
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-LinaUserGroup -Name "MyUserGroup" | Remove-LinaUserGroup
Same example as #1 but using piped commands
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-LinaUserGroup -Name "MyUserGroup*" | Remove-LinaUserGroup -Bulk -WhatIf
Simulates deletion of a multiple User Groups by name (WhatIf mode)
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-LinaUserGroup -Name "MyUserGroup*" | Remove-LinaUserGroup -Bulk
Real deletion of a multiple User Groups by name.
RELATED LINKS
SYNOPSIS
Deletes a User Group from a Lina Server.
SYNTAX
Remove-LinaUserGroup -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]
Remove-LinaUserGroup -LinaObjects <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]
DESCRIPTION
Deletes a User Group.
PARAMETERS
-LinaObjects <PSObject[]>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String>
Name of the User Group(s) to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on
multiple groups).
Note : Be careful, multiple User Profiles 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 Group(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 User Groups. If not set only one User Group 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 LinaUserGroup objects (from Get-LinaUserGroup for example)
OUTPUTS
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-LinaUserGroup -Name "MyUserGroup"
Real deletion of a single User Group by name
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-LinaUserGroup -Name "MyUserGroup" | Remove-LinaUserGroup
Same example as #1 but using piped commands
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-LinaUserGroup -Name "MyUserGroup*" | Remove-LinaUserGroup -Bulk -WhatIf
Simulates deletion of a multiple User Groups by name (WhatIf mode)
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-LinaUserGroup -Name "MyUserGroup*" | Remove-LinaUserGroup -Bulk
Real deletion of a multiple User Groups by name.
RELATED LINKS