Private/New-HaloDELETERequest.ps1
|
#Requires -Version 7 function New-HaloDELETERequest { <# .SYNOPSIS Sends a formatted web request to the Halo API. .DESCRIPTION Wrapper function to send delete requests to the Halo API .OUTPUTS Outputs an object containing the response from the web request. #> [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'Private function - no need to support.')] [OutputType([Object])] Param( # Endpoint for Delete Request [Parameter( Mandatory = $True )] [string]$Resource ) Invoke-HaloPreFlightChecks try { $WebRequestParams = @{ Method = 'DELETE' Uri = "$($Script:HAPIConnectionInformation.URL)$($Resource)" } $DeleteResults = Invoke-HaloRequest -WebRequestParams $WebRequestParams Return $DeleteResults } catch { $ErrorRecord = @{ ExceptionType = 'System.Net.Http.HttpRequestException' ErrorMessage = 'DELETE request sent to the Halo API failed.' InnerException = $_.Exception ErrorID = 'HaloDELETERequestFailed' ErrorCategory = 'ProtocolError' TargetObject = $_.TargetObject ErrorDetails = $_.ErrorDetails BubbleUpDetails = $True } $RequestError = New-HaloErrorRecord @ErrorRecord $PSCmdlet.ThrowTerminatingError($RequestError) } } |