Private/Resolve-InvokeWebRequest.ps1

Function Resolve-InvokeWebRequest {
    <#
        .SYNOPSIS
            Resolve a URL that returns a 301/302 response and returns the redirected URL
            Uses Invoke-WebRequest to find 301/302 headers and return the ResponseUri
    #>

    [OutputType([System.String])]
    [CmdletBinding(SupportsShouldProcess = $False)]
    param (
        [Parameter(Mandatory = $True, Position = 0)]
        [ValidateNotNullOrEmpty()]
        [System.String] $Uri,

        [Parameter(Position = 1)]
        [ValidateNotNullOrEmpty()]
        [System.String] $UserAgent = [Microsoft.PowerShell.Commands.PSUserAgent]::Chrome,

        [Parameter(Position = 2)]
        [ValidateNotNullOrEmpty()]
        [System.Int32] $MaximumRedirection = 0
    )

    # Build the Invoke-WebRequest parameters; Use ErrorAction:SilentlyContinue to enable the try/catch to work
    $iwrParams = @{
        MaximumRedirection = $MaximumRedirection
        Uri                = $Uri
        UseBasicParsing    = $True
        UserAgent          = $UserAgent
        ErrorAction        = "SilentlyContinue"
    }
    Write-Verbose -Message "$($MyInvocation.MyCommand): Resolving URI: [$Uri]."
    ForEach ($item in $iwrParams.GetEnumerator()) {
        Write-Verbose -Message "$($MyInvocation.MyCommand): Invoke-RestMethod parameter: [$($item.name): $($item.value)]."
    }

    if (Test-PSCore) {
        try {
            # If running PowerShell Core, request URL and catch the response
            Invoke-WebRequest @iwrParams | Out-Null
        }
        catch [System.Exception] {
            $redirectUrl = $_.Exception.Response.Headers.Location.AbsoluteUri
            Write-Verbose -Message "$($MyInvocation.MyCommand): Response: [$($_.Exception.Response.StatusCode) - $($_.Exception.Response.ReasonPhrase)]."
        }
    }
    else {
        try {
            # If running Windows PowerShell, request the URL and return the response
            $response = Invoke-WebRequest @iwrParams
            $redirectUrl = $response.Headers.Location
            Write-Verbose -Message "$($MyInvocation.MyCommand): Response: [$($response.StatusCode) - $($response.StatusDescription)]."
        }
        catch [System.Exception] {
            Write-Warning -Message "$($MyInvocation.MyCommand): Error at URI: $Uri."
            Write-Warning -Message "$($MyInvocation.MyCommand): Response: [$($_.Exception.Response.StatusCode) - $($_.Exception.Response.ReasonPhrase)]."
            Write-Warning -Message "$($MyInvocation.MyCommand): For troubleshooting steps see: $($script:resourceStrings.Uri.Info)."
            Write-Error -Message "$($MyInvocation.MyCommand): $($_.Exception.Message)."
        }
    }

    # Validate and return the resolved URL to the pipeline
    if ($Null -ne $redirectUrl) {
        if ($redirectUrl.GetType() -eq [System.String]) {
            Write-Output -InputObject $redirectUrl
        }
        else {
            Write-Warning -Message "$($MyInvocation.MyCommand): failed to resolve correct output type (String)."
        }
    }
    else {
        Write-Warning -Message "$($MyInvocation.MyCommand): failed to resolve a redirect at: $Uri."
    }
}