Private/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 ) if ($null -eq $Script:HAPIConnectionInformation) { Throw "Missing Halo connection information, please run 'Connect-HaloAPI' first." } if (($null -eq $Script:HAPIAuthToken) -and ($null -eq $AllowAnonymous)) { Throw "Missing Halo authentication tokens, please add '-AllowAnonymous' to the PowerShell command to return public data (if supported)." } $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)" } } else { $AuthHeaders = $null } try { Write-Verbose "Making a $($WebRequestParams.Method) request to $($WebRequestParams.Uri)" $Response = Invoke-WebRequest @WebRequestParams -Headers $AuthHeaders -ContentType "application/json" Write-Debug "Response headers: $($Response.Headers | Out-String)" if ($RawResult) { $Results = $Response } else { $Results = $Response.Content | ConvertFrom-Json } return $Results } catch { $ExceptionResponse = $_.Exception.Response Write-Verbose $ExceptionResponse | Out-String Write-Error "The Halo API request `($($ExceptionResponse.Method) $($ExceptionResponse.ReponseUri)`) responded with $($ExceptionResponse.StatusCode.Value__): $($ExceptionResponse.StatusDescription). You'll see more detail if using '-Verbose'" Write-Verbose $_ } } |