Public/Invoke-HaloRequest.ps1
|
#Requires -Version 7 function Invoke-HaloRequest { <# .SYNOPSIS Sends a request to the Halo API. .DESCRIPTION Wrapper function to send web requests to the Halo API. .OUTPUTS Outputs an object containing the response from the web request. #> [Cmdletbinding()] [OutputType([Object])] param ( # Hashtable containing the web request parameters. [Hashtable]$WebRequestParams, # Returns the Raw result. Useful for file downloads. [Switch]$RawResult ) $ProgressPreference = 'SilentlyContinue' Invoke-HaloPreFlightCheck $Now = Get-Date if ($Script:HAPIAuthToken.Expires -le $Now) { Write-Verbose 'The auth token has expired, renewing.' $ReconnectParameters = @{ URL = $Script:HAPIConnectionInformation.URL ClientId = $Script:HAPIConnectionInformation.ClientID ClientSecret = $Script:HAPIConnectionInformation.ClientSecret Scopes = $Script:HAPIConnectionInformation.AuthScopes Tenant = $Script:HAPIConnectionInformation.Tenant } Connect-HaloAPI @ReconnectParameters } if ($null -ne $Script:HAPIAuthToken) { $AuthHeaders = @{ Authorization = "$($Script:HAPIAuthToken.Type) $($Script:HAPIAuthToken.Access)" } if ($null -ne $Script:HAPIConnectionInformation.AdditionalHeaders) { $RequestHeaders = $AuthHeaders + $Script:HAPIConnectionInformation.AdditionalHeaders } else { $RequestHeaders = $AuthHeaders } } else { $RequestHeaders = $null } $Retries = 0 $BaseDelay = 5 # Base delay of 5 seconds $MaxDelay = 60 # Maximum delay of 60 seconds do { $Retries++ Write-Verbose "Attempt $Retries of 10" try { Write-Verbose "Making a $($WebRequestParams.Method) request to $($WebRequestParams.Uri)" $Response = Invoke-WebRequest @WebRequestParams -Headers $RequestHeaders -ContentType 'application/json; charset=utf-8' if ($Response) { Write-Debug "Response headers: $($Response.Headers | Out-String)" Write-Debug "Raw Response: $($Response | Out-String)" Write-Debug "Response Members: $($Response | Get-Member | Out-String)" $Success = $True if ($RawResult) { $Results = $Response } else { $Results = ($Response.Content | ConvertFrom-Json -Depth 100) } } else { Write-Debug 'Response was null.' } } catch [Microsoft.PowerShell.Commands.HttpResponseException] { $Success = $False if ($_.Exception.Response.StatusCode.value__ -eq 429) { $WaitTime = [math]::Min($BaseDelay * [math]::Pow(2, $Retries - 1), $MaxDelay) Write-Warning "The request was throttled, waiting for $WaitTime seconds." Start-Sleep -Seconds $WaitTime continue } else { throw $_ break } } catch { throw $_ } Write-Verbose 'Request successful.' } while ((-not $Results) -and ($Retries -lt 10) -and (-not $Success)) if ($Results) { Write-Verbose 'Request returned results.' Return $Results } else { Write-Verbose 'Request unsuccessful.' if ($Retries -gt 1) { New-HaloError -ModuleMessage ('Retried request to "{0}" {1} times, request unsuccessful.' -f $WebRequestParams.Uri, $Retries) } } } |