Functions/Public/Remove-AMUserGroupMember.ps1
|
function Remove-AMUserGroupMember { <# .SYNOPSIS Removes users from an Automate user group. .DESCRIPTION Remove-AMUserGroupMember can remove users from a user group. .PARAMETER InputObject The user group to modify. .PARAMETER User The users(s) to remove from the user group. .INPUTS The following Automate object types can be modified by this function: UserGroup .OUTPUTS None .EXAMPLE # Remove all users from a user group Get-AMUserGroup "All Users" | Remove-AMUserGroupMember -User * .EXAMPLE # Remove a user from a user group (using user object) Get-AMUserGroup | Remove-AMUserGroupMember -User (Get-AMUser "John") .LINK https://github.com/AutomatePS/AutomatePS/blob/master/Docs/Remove-AMUserGroupMember.md #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact="Medium")] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true)] [ValidateNotNullOrEmpty()] $InputObject, [Parameter(Mandatory = $true, Position = 0)] [ValidateNotNullOrEmpty()] $User ) PROCESS { foreach ($obj in $InputObject) { if ($obj.Type -eq "UserGroup") { $update = Get-AMUserGroup -ID $obj.ID -Connection $obj.ConnectionAlias $shouldUpdate = $false foreach ($u in $User) { if ($u.PSObject.Properties.Name -contains "Type") { if ($u.Type -ne "User") { throw "Unsupported input type '$($u.Type)' encountered!" } } elseif ($u -is [string]) { $tempUser = Get-AMUser -Name $u -Connection $obj.ConnectionAlias if ($tempUser) { $u = $tempUser } else { throw "User '$u' not found!" } } if ($update.UserIDs -contains $u.ID) { $update.UserIDs = @($update.UserIDs | Where-Object {$_ -ne $u.ID}) $shouldUpdate = $true Write-Verbose "Removing user '$($u.Name)' from user group '$($obj.Name)'." } else { Write-Verbose "User '$($u.Name)' not present in user group '$($obj.Name)'." } } if ($shouldUpdate) { $update | Set-AMObject Write-Verbose "Completed removing users from user group '$($obj.Name)'." } } else { Write-Error -Message "Unsupported input type '$($obj.Type)' encountered!" -TargetObject $obj } } } } |