-
Notifications
You must be signed in to change notification settings - Fork 0
/
AzureKQLPowerShellExtractor.psm1
267 lines (189 loc) · 8.44 KB
/
AzureKQLPowerShellExtractor.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
function Get-AzureKQLPowerShellExtract {
param(
[Parameter(Mandatory = $false, ValueFromPipeline = $false, Position = 0)]
[string]$kqlQueryPath = "empty",
[switch]$inExcel = $false,
[switch]$inJSON = $false,
[switch]$h = $false,
[switch]$inCSV = -not ($inJSON -and $inExcel)
)
if ($h) {
help
return
}
if ($kqlQueryPath -eq "empty") {
Write-Error "Path to the KQL Query is missing. Please provide the path to the KQL Query and pass it to the -kqlQueryPath Argument" -Category InvalidArgument
return
}
Write-Host "Export format selected - Excel: $inExcel, CSV: $inCSV, JSON: $inJSON" -ForegroundColor Yellow
Login
Write-host "Querying for data" -ForegroundColor Yellow
$query = Get-Content $kqlQueryPath -Raw
$queryRows = $query + " | summarize count() "
$RowsResult = Search-AzGraph -Query $queryRows
$ResultRows = $RowsResult.count_
Write-Host Total $ResultRows rows to be fetched -ForegroundColor Blue
$batchSize = 1000
$totalRows = 0
#$skipToken = $null
$JSONdata = $null
Exists -Excel inExcel -CSV inCSV -JSON inJSON
# Set initial values
$throttleLimit = 15
$throttleWindow = 5
$remainingQuota = $throttleLimit
$lastRequestTime = Get-Date
$subscriptions = Get-AzSubscription
$subscriptionIds = $subscriptions.Id
# Grouping queries by subscription
foreach ($ID in $subscriptionIds) {
$skipToken = $null
$retryCount = 0
do {
# Staggering queries
if ($remainingQuota -le 0) {
$timeSinceLastRequest = (Get-Date) - $lastRequestTime
if ($timeSinceLastRequest.TotalSeconds -lt $throttleWindow) {
Start-Sleep -Seconds ($throttleWindow - $timeSinceLastRequest.TotalSeconds)
}
$remainingQuota = $throttleLimit
}
try {
$results = Search-AzGraph -Query $query -First $batchSize -SkipToken $skipToken -Subscription $ID
# Output data
if ($inJSON -eq $true) {
$JSONdata += $results
}
if ($inExcel -eq $true) {
$P = "result.xlsx"
$results | Export-Excel -Path $P -Append
}
if ($inCSV -eq $true) {
$P = "result.csv"
$results | Export-Csv -Path $P -Append -NoTypeInformation
}
# Update skip token and progress
$skipToken = $results.SkipToken
Write-Progress -Activity "Fetching data" -Status "Fetched $totalRows rows so far" -PercentComplete (($totalRows / $ResultRows) * 100)
$totalRows += $results.Count
# Update remaining quota and last request time
$remainingQuota--
$lastRequestTime = Get-Date
$retryCount = 0
}
catch {
<#Do this if a terminating exception happens#>
Write-Error $_.Exception.Message
# Handle error and retry or skip batch if necessary
$retryCount++
if ($retryCount -gt 3) {
Write-Warning "Failed to query data after $retryCount attempts. Skipping batch."
break
}
else {
Write-Warning "Error encountered during query. Retrying in 20 seconds..."
Start-Sleep -Seconds 20
}
}
# Query data
} while ($null -ne $skipToken)
}
if ($inJSON -eq $true) {
$json = $JSONdata | ConvertTo-Json
$json | Out-File "result.json"
}
Write-Host "Fetched a total of $totalRows rows available at $PWD "-ForegroundColor Green
}
# do {
# $results = Search-AzGraph -Query $query -First $batchSize -SkipToken $skipToken
# # Output -data $results -Excel $inExcel -CSV $inCSV
# if ($inJSON -eq $true) {
# $JSONdata += $results
# }
# if ($inExcel -eq $true) {
# $P = "result.xlsx"
# $results | Export-Excel -Path $P -Append
# }
# if ($inCSV -eq $true) {
# $P = "result.csv"
# $results | Export-Csv -Path $P -Append -NoTypeInformation
# }
# $skipToken = $results.SkipToken
# $currentBatch++
# Write-Progress -Activity "Fetching data" -Status "Fetched $totalRows rows so far" -PercentComplete (($totalRows / $ResultRows) * 100)
# $totalRows += $results.Count
# } while ($null -ne $skipToken)
function Login () {
$context = Get-AzContext
if (!$context) {
Connect-AzAccount
if ($? -eq "False") {
Write-Error "Error: Connect to Azure Account to proceed" -RecommendedAction "Disconnect using Disconnect-AzAccount and reconnect using Connect-AzAccount"
}
}
else {
Write-Host "Connected to Azure" -ForegroundColor Green
Write-Host "Connected Account" $(Get-AzContext).Account "to" $(Get-AzContext).Tenant.Id
}
}
function help () {
Write-Host "Description" -ForegroundColor Green
Write-Host "
With this script you will be able to generate the results of Azure Resource Graph (ARG) queries locally in csv, excel or json format.
This script also helps to mitigate the limitation of running ARG queries on Azure Resource Graph Explorer on Azure Portal and the maximum rows that can be downloaded at a time per query. Project and documentation is available at - https://github.com/G-Lucifer/AzureKQLPowerShellExtractor .
The new results file will generated from where the Get-AzureKQLPowerShellExtract is invoked."
Write-Host "Examples" -ForegroundColor Green
Write-Host "To generate a CSV file "
Write-Host "Get-AzureKQLPowerShellExtract .\sample.kql -inCSV" -ForegroundColor Yellow
Write-Host "To generate a JSON file "
Write-Host "Get-AzureKQLPowerShellExtract -kqlQueryPath .\sample.kql -inJSON" -ForegroundColor Yellow
Write-Host "To generate an Excel file "
Write-Host "Get-AzureKQLPowerShellExtract -kqlQueryPath .\sample.kql -inExcel" -ForegroundColor Yellow
Write-Host "To generate all three types of file "
Write-Host "Get-AzureKQLPowerShellExtract -kqlQueryPath .\sample.kql -inCSV -inExcel -inJSON" -ForegroundColor Yellow
Write-Host "Arguments" -ForegroundColor Green
Write-Host "-kqlQueryPath {Mandatory Parameter, Postitional Argument, Requires Path to the KQL file}"
Write-Host "-inExcel {Optional Flag, Mention this to generate result.xlsx file}"
Write-Host "-inJSON {Optional Flag, Mention this to generate result.json file}"
Write-Host "-inCSV {Optional Flag, Mention this to generate result.csv file}"
Write-Host "-h {Optional Flag, Mention this for help}"
}
function Exists () {
param(
[switch]$Excel = $false,
[switch]$CSV = $false,
[switch]$JSON = $false
)
if (($inJSON -eq $true) -and (Test-Path -Path "result.json") ) {
Write-Information "Removing the existing result.json file"
Remove-Item "result.json"
}
if (($inExcel -eq $true) -and (Test-Path -Path "result.xlsx") ) {
Write-Information "Removing the existing result.xlsx file"
Remove-Item "result.xlsx"
}
if (($inCSV -eq $true) -and (Test-Path -Path "result.csv") ) {
Write-Information "Removing the existing result.csv file"
Remove-Item "result.csv"
}
}
# function Output () {
# param(
# [Parameter(Mandatory = $true)]
# $data,
# [switch]$Excel = $false,
# [switch]$CSV = $false
# )
# Write-Host "Excel: $Excel, CSV: $CSV"
# if ($Excel) {
# $P = "result.xlsx"
# $data | Export-Excel -Path $P -Append
# Write-Host "p is $P"
# }
# if ($CSV) {
# $P ="result.csv"
# $data | Export-Csv -Path $P -Append -NoTypeInformation
# Write-Host "p is $P "
# }
# }
Export-ModuleMember -Function Get-AzureKQLPowerShellExtract