Private/Select-ArmorApiResult.ps1
|
function Select-ArmorApiResult { <# .SYNOPSIS Criteria-based object filtering. .DESCRIPTION Filters objects returned from an Armor API endpoint for result object property values matching parameter values. Wildcard filtering is supported via the use of the `-like` operator. .INPUTS PSObject[] PSCustomObject .NOTES - Troy Lindsay - Twitter: @troylindsay42 - GitHub: tlindsay42 .EXAMPLE $results = Submit-ArmorApiRequest -Uri 'https://api.armor.com/vms'; $filters = $resources.Filter | Get-Member -MemberType 'NoteProperty'; $results = Select-ArmorApiResult -Results $results -Filters $filters Sets $results to the VMs matching the parameters defined in the calling cmdlet: `Get-ArmorVM`, such as 'Name'='TEST-VM'. There are no available use cases for the bi-level filter yet, but one example is to define a filter key in ApiData.json such as `"SKU": "Product.SKU"`, and then define a $SKU parameter for `Get-ArmorVM`, so that you could then filter for VMs by SKU via the `Get-ArmorVM` cmdlet. .LINK https://tlindsay42.github.io/ArmorPowerShell/private/Select-ArmorApiResult/ .LINK https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Private/Select-ArmorApiResult.ps1 .LINK https://docs.armor.com/display/KBSS/Armor+API+Guide .LINK https://developer.armor.com/ #> [CmdletBinding()] [OutputType( [PSCustomObject[]] )] [OutputType( [PSCustomObject] )] param ( # Specifies the formatted API response contents. [Parameter( Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [AllowEmptyCollection()] [PSCustomObject[]] $Results = @(), <# Specifies the list of parameters that the user can use to filter response data. Each key is the parameter name without the "$" and each value corresponds to the response data's key. If a '.' is included in the key name, the filter key name will be split so that the first part of the filter key will be applied to a root-level property in the result object, and the second part will be applied to a child property within the parent property. #> [Parameter( Position = 1 )] [AllowEmptyCollection()] [PSCustomObject[]] $Filters = @() ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message "Beginning: '${function}'." } # End of begin process { [PSCustomObject[]] $return = $null if ( $Results.Count -eq 0 -or $Filters.Count -eq 0 ) { $return = $Results } else { $filteredResults = $Results.Clone() Write-Verbose -Message 'Filter the results.' foreach ( $filter in $Filters ) { $filterValueName = $filter.Definition.Split( '=' )[-1] $filterValue = ( Get-Variable -Name $filter.Name -ErrorAction 'SilentlyContinue' ).Value.ToString() if ( $filterValue.Length -gt 0 ) { Write-Verbose -Message "Filter match = ${filterValueName}=${filterValue}" if ( $filterValueName -match '\.' ) { $filterList = $filterValueName.Split( '.' ) } else { $filterList = @( $filterValueName ) } Write-Verbose -Message ( 'Filter depth: ' + $filterList.Count ) switch ( $filterList.Count ) { 1 { Write-Verbose -Message ( 'Results count pre-filter: ' + $filteredResults.Count ) $filteredResults = $filteredResults.Where( { $_.$filterValueName -like $filterValue } ) Write-Verbose -Message ( 'Results count post-filter: ' + $filteredResults.Count ) } 2 { $parentFilter = $filterList[0] $childFilter = $filterList[1] if ( $parentFilter -eq '' -or $childFilter -eq '' ) { throw "Invalid Armor API filter configuration: '${filterValue}'" } Write-Verbose -Message ( 'Results count pre-filter: ' + $filteredResults.Count ) $filteredResults = $filteredResults.Where( { $_.$parentFilter.$childFilter -like $filterValue } ) Write-Verbose -Message ( 'Results count post-filter: ' + $filteredResults.Count ) } default { throw "Unsupported Armor API filter configuration: '${filterValue}'" } } } } $return = $filteredResults } $return } # End of process end { Write-Verbose -Message "Ending: '${function}'." } # End of end } # End of function |