Functions/Invoke-RestMethod.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
function Invoke-RestMethod {
    [CmdletBinding(HelpUri='http://go.microsoft.com/fwlink/?LinkID=217034')]
    param(
        [Microsoft.PowerShell.Commands.WebRequestMethod]
        ${Method},

        [switch]
        ${UseBasicParsing},

        [Parameter(Mandatory=$true, Position=0)]
        [ValidateNotNullOrEmpty()]
        [uri]
        ${Uri},

        [Microsoft.PowerShell.Commands.WebRequestSession]
        ${WebSession},

        [Alias('SV')]
        [string]
        ${SessionVariable},

        [pscredential]
        [System.Management.Automation.CredentialAttribute()]
        ${Credential},

        [switch]
        ${UseDefaultCredentials},

        [ValidateNotNullOrEmpty()]
        [string]
        ${CertificateThumbprint},

        [ValidateNotNull()]
        [X509Certificate]
        ${Certificate},

        [string]
        ${UserAgent},

        [switch]
        ${DisableKeepAlive},

        [ValidateRange(0, 2147483647)]
        [int]
        ${TimeoutSec},

        [System.Collections.IDictionary]
        ${Headers},

        [ValidateRange(0, 2147483647)]
        [int]
        ${MaximumRedirection},

        [uri]
        ${Proxy},

        [pscredential]
        [System.Management.Automation.CredentialAttribute()]
        ${ProxyCredential},

        [switch]
        ${ProxyUseDefaultCredentials},

        [Parameter(ValueFromPipeline=$true)]
        [System.Object]
        ${Body},

        [string]
        ${ContentType},

        [ValidateSet('chunked','compress','deflate','gzip','identity')]
        [string]
        ${TransferEncoding},

        [string]
        ${InFile},

        [string]
        ${OutFile},

        [switch]
        ${PassThru},
        
        [ValidateSet('Basic')]
        [string]
        $Authentication = 'Basic',
        
        [string]
        $User,
        
        [string]
        $Token,
        
        [switch]
        $NoCache
    )

    begin
    {
        if (-not $Headers) {
            $Headers = @{}
        }
        if ($User -and $Token -and -not $Headers.ContainsKey('Authorization')) {
            $AuthString = Get-BasicAuthentication -User $User -Token $Token
            $null = $Headers.Add('Authorization', "$Authentication $AuthString")
        }

        # Workaround for PSBoundParameters not being updated by modifying parameter
        $WrappedParameters = $PSBoundParameters
        $null = $WrappedParameters.Remove('Authentication')
        $null = $WrappedParameters.Remove('User')
        $null = $WrappedParameters.Remove('Token')
        $null = $WrappedParameters.Remove('NoCache')
        $WrappedParameters.Headers = $Headers
    }

    process
    {
        if (-not $NoCache) {
            $Response = Get-CachedWebRequest -Uri $Uri
            if ($Response) {
                $Response.Content | ConvertFrom-Json
                return
            }
        }

        $ConfiguredProtocols = [System.Net.ServicePointManager]::SecurityProtocol
        [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]'Tls11,Tls12'
        $Response = Microsoft.PowerShell.Utility\Invoke-WebRequest @WrappedParameters
        [System.Net.ServicePointManager]::SecurityProtocol = $ConfiguredProtocols

        Add-CachedWebRequest -Uri $Uri -Response $Response
        $Response.Content | ConvertFrom-Json
        
        Update-CachedWebRequest
    }
}