Public/Get-LMUserGroup.ps1
|
<# .SYNOPSIS Retrieves user group information from LogicMonitor. .DESCRIPTION The Get-LMUserGroup function retrieves user group information from LogicMonitor based on specified parameters. It can return a single user group by ID or multiple groups based on name, filter, or filter wizard. .PARAMETER Id The ID of the user group to retrieve. This parameter is mandatory when using the Id parameter set. .PARAMETER Name The name of the user group to retrieve. This parameter is mandatory when using the Name parameter set. .PARAMETER Filter A filter object to apply when retrieving user groups. This parameter is mandatory when using the Filter parameter set. .PARAMETER FilterWizard A switch parameter to enable the filter wizard interface. This parameter is mandatory when using the FilterWizard parameter set. .PARAMETER BatchSize The number of results to return per request. Must be between 1 and 1000. Default is 1000. .EXAMPLE #Retrieve a user group by ID Get-LMUserGroup -Id 1234 .EXAMPLE #Retrieve a user group by name Get-LMUserGroup -Name "Administrators" .EXAMPLE #Retrieve user groups using a filter Get-LMUserGroup -Filter $filterObject .NOTES You must run Connect-LMAccount before running this command. .INPUTS None. You cannot pipe objects to this command. #> function Get-LMUserGroup { [CmdletBinding(DefaultParameterSetName = 'All')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Required for the FilterWizard to work')] param ( [Parameter(ParameterSetName = 'Id')] [Int]$Id, [Parameter(ParameterSetName = 'Name')] [String]$Name, [Parameter(ParameterSetName = 'Filter')] [Object]$Filter, [Parameter(ParameterSetName = 'FilterWizard')] [Switch]$FilterWizard, [ValidateRange(1, 1000)] [Int]$BatchSize = 1000 ) #Check if we are logged in and have valid api creds if ($Script:LMAuth.Valid) { #Build header and uri $ResourcePath = "/setting/admin/groups" #Initalize vars $QueryParams = "" $Count = 0 $Done = $false $Results = @() #Loop through requests while (!$Done) { #Build query params switch ($PSCmdlet.ParameterSetName) { "All" { $QueryParams = "?size=$BatchSize&offset=$Count&sort=+id" } "Id" { $resourcePath += "/$Id" } "Name" { $QueryParams = "?filter=name:`"$Name`"&size=$BatchSize&offset=$Count&sort=+id" } "Filter" { #List of allowed filter props $PropList = @() $ValidFilter = Format-LMFilter -Filter $Filter -PropList $PropList $QueryParams = "?filter=$ValidFilter&size=$BatchSize&offset=$Count&sort=+id" } "FilterWizard" { $PropList = @() $Filter = Build-LMFilter -PassThru $ValidFilter = Format-LMFilter -Filter $Filter -PropList $PropList $QueryParams = "?filter=$ValidFilter&size=$BatchSize&offset=$Count&sort=+id" } } $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $ResourcePath $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + $QueryParams Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request $Response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] #Stop looping if single device, no need to continue if ($PSCmdlet.ParameterSetName -eq "Id") { $Done = $true return $Response } #Check result size and if needed loop again else { [Int]$Total = $Response.Total [Int]$Count += ($Response.Items | Measure-Object).Count $Results += $Response.Items if ($Count -ge $Total) { $Done = $true } } } return $Results } else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } |