GraphFast.psm1
|
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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
<#
.Synopsis Executes Microsoft Graph queries quickly .DESCRIPTION This cmdlet allows you to run bulk Microsoft Graph API requests quickly. Internally it uses both multi-threading (via PS runspaces) and implements the Odata batching functionality of the Graph API. This can result in speed increases of up to and over 60x. .EXAMPLE Invoke-GraphFast -ClientId 12345678-1234-1234-1234-123456789012 -ClientSecret "324trgh7b4b3a!sgfn3p9757a9ewhg7a" -TenantId 12345678-1234-1234-1234-123456789012 -Urls ("/teams/[TEAMID]","/teams/[TEAMID]","/teams/[TEAMID]",.....) #> function Invoke-GraphFast { [CmdletBinding()] param( # A Microsoft Graph access token. If specified with a ClientID, the cmdlet will derive the tenantId from the token, even if the TeantID parameter is provided [Parameter(ParameterSetName = 'Tokens')][Parameter(ParameterSetName = 'ClientId')] $AccessToken, # A Microsoft Graph refresh token [Parameter(ParameterSetName = 'Tokens')] $RefreshToken, # The ClientId of a Microsoft Azure AD Application Registration [Parameter(ParameterSetName = 'ClientId')] $ClientId, # An authentication secret of the Microsoft Azure AD Application Registration [Parameter(ParameterSetName = 'ClientId')] $ClientSecret, # The Microsoft Azure AD TenantId (GUID or domain) [Parameter(ParameterSetName = 'ClientId')] $TenantId, # The Microsoft Graph endpoint to use (v1.0 or beta) $Endpoint = "v1.0", # A single Graph URL or a collection of URLs. This may be the full Graph URL or may begin with the portion after the endpoint (eg. /users/myuser@mydomain.com). If the full URL is provided, the endpoint is ignored and the value of the -Endpoint parmeter is used. $Urls, # Sets the ConsistencyLevel header for Graph calls that need it. $ConsistencyLevel, # Switch to disable retrieving paged results [Switch] $NoPaging, # Sets the PowerShell runspace pool size. By default this is one more than the number of logical processors $PoolSize = (1 + $Env:NUMBER_OF_PROCESSORS), # The maximum number of times to retry requests that return any status code other than 200, 403, 404, or 429 $MaxRetries = 3, # If specified, the raw results of the batch response will be returned with all requests, including ones that failed $ReturnErrors = $false, #If set to true, this will return the content of non 200 responses # If specified, the raw results of the batch response will be returned with all requests that returned status code 200 $ReturnAll = $false, #If set to false, this will return the full response and not just the body, # By default, if the number of URLs provided is over 100, this cmdlet will output status updates on the Information stream $ShowProgress = $true, # When ShowProgress is true, if this value is set, update messages will only be displayed every X minutes $UpdateInterval, # When ShowProgress is true, if this value is not set to false, at the end, a total objects processed message will be displayed. $ShowTotals = $true, # When ShowProgress is true, this value will be used to populate the output messages eg. "Total groups processed: 100 of 2134" $ItemType = "objects", # Used internally to pass a collection of GraphBatch objects instead of URLs. [Parameter(DontShow)] $GraphBatch, # Used internally to track retrys [Parameter(DontShow)] $retry = 0, # This should not be set by users, it will be set by recursive calls # Used internally to alter functionality when paging results [Parameter(DontShow)] $large = $false, # Used internally to handle credentials during recursive calls [Parameter(DontShow)] $tokens ) Begin { class GraphBatch { [string]$id [string]$method = "GET" [string]$url GraphBatch ([string]$url) { $this.url = $url.Replace("https://graph.microsoft.com/v1.0", "").Replace("https://graph.microsoft.com/beta", "").Replace("//", "/") $this.id = $this.url } GraphBatch ([string]$idOrMethod, [string]$url) { $this.url = $url.Replace("https://graph.microsoft.com/v1.0", "").Replace("https://graph.microsoft.com/beta", "").Replace("//", "/") if ($idOrMethod -in ("Default", "Delete", "Get", "Head", "Merge", "Options", "Patch", "Post", "Put")) { $this.Method = $idOrMethod.ToUpper() } else { $this.id = $idOrMethod } } GraphBatch ([string]$id, [string]$method, [string]$url) { if ($Method -notin ("Default", "Delete", "Get", "Head", "Merge", "Options", "Patch", "Post", "Put")) { Throw "Invalid Method" } $this.Method = $method.ToUpper() $this.id = $id $this.url = $url.Replace("https://graph.microsoft.com/v1.0", "").Replace("https://graph.microsoft.com/beta", "").Replace("//", "/") } } function Test-AccessToken ($tokens) { try { if ($null -eq $tokens.AccessToken) { Get-Tokens $tokens } else { $tokens.jwt = Get-JWTDetails $tokens.accessToken -Verbose:$false if ($jwt.TimeToExpiry -lt (New-TimeSpan -Minutes 5)) { Get-Tokens $tokens } else { $tokens } } } catch { Get-Tokens $tokens } $PSDefaultParameterValues."Invoke-RestMethod:Headers" = @{Authorization = "Bearer $($tokens.accessToken)" } } function Get-Tokens ($tokens) { #Handle Case a clientID and secret are passed in without an accesstoken $tid = $tokens.jwt.tid if ($null -eq $tid) { if ($tokens.tid) { $tid = $tokens.tid } else { $tid = "organizations" } } if ($tokens.ClientId) { $body = @{ client_id = $tokens.clientId scope = ".default" grant_type = "client_credentials" client_secret = $tokens.clientSecret } } else { $body = @{ client_id = $tokens.jwt.appid scope = $tokens.jwt.scp grant_type = "refresh_token" refresh_token = $tokens.refreshToken } } $return = Invoke-RestMethod "https://login.microsoftonline.com/$tid/oauth2/v2.0/token" -Method POST -Body $body $tokens.RefreshToken = $return.refresh_token $tokens.AccessToken = $return.access_token $tokens.jwt = Get-JWTDetails $tokens.accessToken -Verbose:$false $PSDefaultParameterValues."Invoke-RestMethod:Headers" = @{Authorization = "Bearer $($tokens.accessToken)" } $tokens } } process { trap { Write-Error "UNHANDLED EXCEPTION" Write-Error "----------------------------------------" Write-Error "Error: $($_ | Out-String)" } #Populate Tokens Object if it isn't already if ($null -eq $tokens) { $tokens = [PSCustomObject]@{ AccessToken = $AccessToken refreshToken = $refreshToken jwt = try { Get-JWTDetails $AccessToken -Verbose:$false } catch { $null }; tid = $tenantId clientId = $clientId clientSecret = $clientSecret } } #Check for Access Token and validity and get a new token if needed $tokens = Test-AccessToken -tokens $tokens #Populate GraphBatch with urls, ignoring duplicates if ($null -eq $GraphBatch) { $GraphBatch = [System.Collections.ArrayList]@() } if ($null -ne $urls) { $urlHashTable = @{} $idHashTable = @{} #Add any GraphBatch objects to the hashtable to prevent incoming urls from creating duplicates foreach ($g in $graphBatch) { $urlHashTable[$g.url] = $null; $idHashTable[$g.id] = $null } foreach ($url in $Urls) { try { $urlHashTable.add($url, $null) try { $idHashTable.add($url, $null) } catch { Write-Warning "Duplicate id in the GraphBatch collection provided."; throw } [void] $GraphBatch.Add([GraphBatch]::new($url)) } catch { Write-Warning "Unable to add duplicate url: $url" } } } #Create RunspacePool $runspacePool = [runspacefactory]::CreateRunspacePool(1, $poolSize) $runspacePool.Open() $jobs = [System.Collections.ArrayList]@() $contentType = "application/json" $uri = "https://graph.microsoft.com/$endpoint/`$batch" #Start Running Batches $x = 0 $runningCount = 0 $pause = 1100 $stopInterval = 100 if ($UpdateInterval) { $UpdateInterval = New-TimeSpan -Minutes $UpdateInterval $timer = New-Object -TypeName System.Diagnostics.Stopwatch $timer.Start() } if ($ConsistencyLevel) { try { $PSDefaultParameterValues."Invoke-RestMethod:Headers".Add("ConsistencyLevel", $ConsistencyLevel) } catch {} } for ($x = 0; $x -lt $graphBatch.count; $x += 20) { if ($showProgress) { $runningCount += $graphBatch[$x..($x + 19)].count } $body = [PSCustomObject] @{requests = $graphBatch[$x..($x + 19)] } | ConvertTo-Json -Depth 10 $body = $body.Replace("\u0027", "'").replace("\u0026", "&") $instance = [powershell]::Create().AddScript( { param($header, $uri, $body, $contentType); Invoke-RestMethod -Method POST -Headers $header -Uri $uri -Body $body -ContentType $contentType }) [void] ($instance.AddArgument($PSDefaultParameterValues."Invoke-RestMethod:Headers")) [void] ($instance.AddArgument($uri)) [void] ($instance.AddArgument($body)) [void] ($instance.AddArgument($contentType)) [void] ($instance.RunspacePool = $runspacePool) [void] $jobs.Add( [PSCustomObject]@{ instance = $instance; job = $instance.BeginInvoke() } ) Start-Sleep -milliseconds 360 #Near optimal dely to prevent throttling if (($x + 20) % $stopInterval -eq 0 -and $x -ne 0) { if ($showProgress) { if ($UpdateInterval) { if ($timer.Elapsed -gt $UpdateInterval) { Write-Information "Total $itemType processed: $runningCount of $($graphBatch.Count)" $timer.Restart() } } else { Write-Information "Total $itemType processed: $runningCount of $($graphBatch.Count)" } } do { $pendingjobs = $jobs | Where-Object { $_.job.isCompleted -eq $false } if (@($pendingjobs).count -ne 0) { #Write-Information "Waiting for $(@($pendingjobs).count) jobs" Start-Sleep -Milliseconds 500 } } while ($false -in $jobs.job.IsCompleted) start-sleep -milliseconds $pause $currentresponses = [System.Collections.ArrayList]@() foreach ($job in $jobs) { foreach ($response in $job.instance.EndInvoke($job.job).responses) { [void] $currentresponses.add($response) } } $throttledResponses = $currentresponses | Select-Object -last 100 | Where-Object status -eq "429" if ($throttledResponses) { $recommendedWait = ($throttledResponses.headers | Measure-object "retry-after" -Maximum).maximum #Write-Information "Sleeping $recommendedWait seconds for too many requests. Request Count: $($throttledResponses.count)" Start-Sleep -Seconds ($recommendedWait + ($pause / 1000)) $pause += 200 } else { if ($pause -gt 1100) { $pause -= 10 } } $tokens = Test-AccessToken -tokens $tokens } } #Wait for Jobs to Complete while ($false -in $jobs.job.IsCompleted) { Start-sleep -Milliseconds 500 } $responses = [System.Collections.ArrayList]@() foreach ($job in $jobs) { foreach ($response in $job.instance.EndInvoke($job.job).responses) { [void] $responses.add($response) } } $runspacePool.close() $runspacePool = $null $tooManyRequests = 0 $retries = [System.Collections.ArrayList]@() foreach ($response in $responses) { switch ($response.status) { 200 { } 403 { } 404 { } 429 { [void] $retries.Add([GraphBatch]::new($response.id)) $tooManyRequests++ } default { [void] $retries.Add([GraphBatch]::new($response.id)) } } } if ($retries.count -gt 0 -and $retry -lt $maxretries) { if ($tooManyRequests -gt 0) { Write-Information "Sleeping for too many requests. Count: $($tooManyRequests)" } Write-Verbose "Retrying $($retries.count) queries:`n$($responses | Group-Object status | out-string)" if ($VerbosePreference -eq "Continue") { $verbose = $true } else { $verbose = $false } if ($tooManyRequests -gt 0) { $retryresponses = Invoke-GraphFast -AccessToken $tokens.AccessToken -RefreshToken $tokens.RefreshToken -GraphBatch $retries -retry $retry -maxRetries $maxretries -Verbose:$Verbose -tokens $tokens -Endpoint $endpoint -ReturnAll $true -showProgress $false -ConsistencyLevel "$ConsistencyLevel" } else { $retryresponses = Invoke-GraphFast -AccessToken $tokens.AccessToken -RefreshToken $tokens.RefreshToken -GraphBatch $retries -retry ($retry + 1) -maxRetries $maxretries -Verbose:$Verbose -tokens $tokens -Endpoint $endpoint -ReturnAll $true -showProgress $false -ConsistencyLevel "$ConsistencyLevel" } } $results = @{} foreach ($r in $responses) { $results.add($r.id, $r) } $successes = $retryResponses | Group-Object status | Where-Object name -eq 200 foreach ($success in $successes.group) { $results[$success.id] = $success } if (-not $NoPaging) { #Now get all responses that have @odata.nextlinks and append the data until there's nothing left while ( $results.values | Where-Object { $null -ne $_.body."@odata.nextLink" -and $large -eq $false }) { $incomplete = [System.Collections.ArrayList]@() foreach ($incompleteBody in $results.values | Where-Object { $null -ne $_.body."@odata.nextLink" }) { [void] $incomplete.add([GraphBatch]::new($incompleteBody.id, $incompleteBody.body."@odata.nextLink")) } if ($VerbosePreference -eq "Continue") { $verbose = $true } else { $verbose = $false } #Write-Host "." -nonewline $largeResponses = Invoke-GraphFast -AccessToken $tokens.AccessToken -RefreshToken $tokens.RefreshToken -GraphBatch $incomplete -retry $retry -maxRetries $maxretries -Verbose:$Verbose -ReturnAll $true -tokens $tokens -Endpoint $endpoint -large $true -ConsistencyLevel "$ConsistencyLevel" foreach ($response in $largeResponses) { $results[$response.id].body.value += $response.body.value try { $results[$response.id].body."@odata.nextLink" = $null $results[$response.id].body."@odata.nextLink" = $response.body."@odata.nextLink" } catch {} } } } if ($showProgress -eq $true -and $large -eq $false -and $showTotals -eq $true) { $ValueNodeChildren = (($results.values | Where-Object { $_.status -eq 200 -and $null -ne $_.body.value }).body.value | Measure-Object).Count $queriesWithOutValueNode = ($results.values | Where-Object { $_.status -eq 200 -and $null -eq $_.body.value } | Measure-Object).Count Write-Information "Total $itemType returned: $($queriesWithOutValueNode + $ValueNodeChildren)" } if ($returnErrors) { if ($returnAll -eq $false) { Write-Output $results.values.body } else { Write-Output $results.values } } else { if ($returnAll -eq $false) { Write-Output ($results.values | Where-Object status -eq 200).body } else { Write-Output ($results.values | Where-Object status -eq 200) } } } End { if ($runspacePool) { [void]($runspacePool.Close()) } } } Export-ModuleMember "Invoke-GraphFast" |