Private/Format-ArmorApiRequestBody.ps1
|
function Format-ArmorApiRequestBody { <# .SYNOPSIS Generates the JSON request body payload for an Armor API request. .DESCRIPTION Retrieves the values of the parameters defined in the parent function that match the names of the specified keys, builds the JSON request body, and then returns the request body payload. .INPUTS None- this function does not accept pipeline inputs. .NOTES - Troy Lindsay - Twitter: @troylindsay42 - GitHub: tlindsay42 .EXAMPLE Format-ArmorApiRequestBody -Keys 'key1', 'key2' -Parameters $parameters Generates a JSON document with the names and values of objects in the $parameters array with names matching key1 & key2. .LINK https://tlindsay42.github.io/ArmorPowerShell/private/Format-ArmorApiRequestBody/ .LINK https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Private/Format-ArmorApiRequestBody.ps1 .LINK https://docs.armor.com/display/KBSS/Armor+API+Guide .LINK https://developer.armor.com/ #> [CmdletBinding()] [OutputType( [String] )] param ( # Specifies the variables available in the endpoint request body schema. [Parameter( Mandatory = $true, Position = 0 )] [AllowEmptyCollection()] [AllowNull()] [String[]] $Keys, # Specifies the parameter names available within the calling cmdlet. [Parameter( Mandatory = $true, Position = 1 )] [ValidateCount( 1, 65535 )] [ValidateNotNullorEmpty()] [PSCustomObject[]] $Parameters ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message "Beginning: '${function}'." $excludedParameters = @( 'ApiVersion', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'WhatIf', 'Confirm' ) } # End of begin process { [String] $return = $null $filteredParameters = $Parameters.Where( { $_.Name -notin $excludedParameters } ) # Inventory all invoked parameters $setParameters = $PSCmdlet.MyInvocation.BoundParameters.Values.Name.Where( { $_ -notin $excludedParameters } ) Write-Verbose -Message "List of set parameters: $( $setParameters -join ', ' )." Write-Verbose -Message 'Build the body parameters.' $body = @{} <# Walk through all of the available body options presented by the endpoint Note: Keys are used to search in case the value changes in the future across different API versions #> foreach ( $key in $Keys ) { Write-Verbose -Message "Adding ${key}..." $keyNoUnderscore = $key -replace '_', '' <# Walk through all of the parameters defined in the function Both the parameter name and parameter alias are used to match against a body option It is suggested to make the parameter name "human friendly" and set an alias corresponding to the body option name #> foreach ( $parameter in $filteredParameters ) { $parameterValue = ( Get-Variable -Name $parameter.Name ).Value # if the parameter name or alias matches the body option name, build a body string if ( $parameter.Name -in $setParameters -and ( $parameter.Name -eq $key -or $parameter.Name -eq $keyNoUnderscore -or $parameter.Aliases -contains $key -or $parameter.Aliases -contains $keyNoUnderscore ) ) { if ( $parameterValue.GetType().Name -eq 'SwitchParameter' ) { $body.Add( $key, $parameterValue.IsPresent ) } else { $body.Add( $key, $parameterValue ) } } } } # Store the results in a JSON string $return = ConvertTo-Json -InputObject $body -ErrorAction 'Stop' Write-Verbose -Message "Body = ${return}" $return } # End of process end { Write-Verbose -Message "Ending: '${function}'." } # End of end } # End of function |