Private/Submit-ArmorApiRequest.ps1
|
function Submit-ArmorApiRequest { <# .SYNOPSIS Helper function used to send data to an endpoint and then format the response for further use. .DESCRIPTION { required: more detailed description of the function's purpose } .NOTES Troy Lindsay Twitter: @troylindsay42 GitHub: tlindsay42 .INPUTS None You cannot pipe objects to Submit-ArmorApiRequest. .OUTPUTS System.Management.Automation.PSCustomObject[] .LINK https://github.com/tlindsay42/ArmorPowerShell .LINK https://docs.armor.com/display/KBSS/Armor+API+Guide .LINK https://developer.armor.com/ .EXAMPLE {required: show one or more examples using the function} #> [CmdletBinding( SupportsShouldProcess = $true )] param ( <# Specifies the Uniform Resource Identifier (URI) of the Armor API resource to which the web request is sent. #> [Parameter( Position = 0 )] [ValidateScript( { $_ -match '^https://.+/.+$' } )] [String] $Uri = '', <# Specifies the headers of the Armor API web request. #> [Parameter( Position = 1 )] [ValidateNotNull()] [Hashtable] $Headers = $Global:ArmorSession.Headers, <# Specifies the action/method used for the Armor API web request. #> [Parameter( Position = 2 )] [ValidateSet( 'Delete', 'Get', 'Patch', 'Post', 'Put' )] [String] $Method = '', <# Specifies the body of the Armor API request. Ignored if the request method is set to Get. #> [Parameter( Position = 3 )] [String] $Body = '', <# Specifies the success code expected in the response. #> [Parameter( Position = 4 )] [ValidateSet( 200 )] [UInt16] $SuccessCode = 200, <# If this cmdlet is called with the -Confirm switch parameter set to true, this optional description will be displayed at the prompt. #> [Parameter( Position = 5 )] [ValidateNotNullorEmpty()] [String] $Description = '' ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message ( 'Beginning {0}.' -f $function ) } # End of begin process { $return = $null $request = $null if ( $PSCmdlet.ShouldProcess( $ID, $Description ) ) { Write-Verbose -Message 'Submitting the request.' if ( $Method -eq 'Get' ) { $getHeaders = $Headers.Clone() $getHeaders.Remove( 'Content-Type' ) $request = Invoke-WebRequest -Uri $Uri -Headers $getHeaders -Method $Method } else { $request = Invoke-WebRequest -Uri $Uri -Headers $Headers -Method $Method -Body $Body } if ( $request.StatusCode -eq $SuccessCode ) { if ( $request.Content.Length -gt 2MB ) { # Because some calls require more than the default payload limit of 2MB, ConvertFrom-JsonXL dynamically adjusts the payload limit Write-Verbose -Message 'Converting JSON payload more than 2MB.' $return = $request.Content | ConvertFrom-JsonXL } else { Write-Verbose -Message 'Converting JSON payload less than or equal to 2MB.' $return = $request.Content | ConvertFrom-Json } } else { throw $request.StatusDescription } } $return } # End of process end { Write-Verbose -Message ( 'Ending {0}.' -f $function ) } # End of end } # End of function |