-
Notifications
You must be signed in to change notification settings - Fork 5
/
OMSSearch.psm1
2481 lines (2118 loc) · 85 KB
/
OMSSearch.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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Function Get-AADToken {
<#
.SYNOPSIS
Get token from Azure AD so you can use the other cmdlets.
.DESCRIPTION
Get token from Azure AD so you can use the other cmdlets.
.PARAMETER OMSConnection
Object that contains all needed parameters for working
with OMSSearch Module. You can create such object in
OMS Automation as connection asset.
.PARAMETER TenantADName
Valid Azure AD Tenant name.
Example: stanoutlook.onmicrosoft.com
.PARAMETER TenantID
Valid Azure Tenant ID.
Example: eeb91fce-4be2-4a30-aad8-39e05fefde0
.PARAMETER Credential
Valid user credentials to Azure AD. The Azure AD user must
have at least user rights in OMS and administrator and
Contributor rights on the Azure resource group where
the OMS workspace is located.
.EXAMPLE
$token = Get-AADToken -TenantADName 'stanoutlook.onmicrosoft.com' -Credential $creds
Description
-----------
Grabs token from Azure AD by Tenant AD Name
Example Variables
-----------------
$creds = Get-Credetnial
.EXAMPLE
$token = Get-AADToken -TenantID 'eeb91fce-4be2-4a30-aad8-39e05fefde0' -Credential $creds
Description
-----------
Grabs token from Azure AD by Tenant ID
Example Variables
-----------------
$creds = Get-Credetnial
.EXAMPLE
$Token = Get-AADToken -OMSConnection $OMSCon
Description
-----------
Grabs token from Azure AD by using information from asset of type connection in OMS Automation
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'stasoutlook'
.OUTPUTS
System.String. Returns token from Azure AD.
#>
[CmdletBinding(DefaultParameterSetName='LoginbyTenantADName')]
[OutputType([string])]
PARAM (
[Parameter(ParameterSetName='OMSConnection',Position=0,Mandatory=$true)]
[Alias('Connection','c')]
[Object]$OMSConnection,
[Parameter(ParameterSetName='LoginbyTenantADName',Position=0,Mandatory=$true)]
[Alias('t')]
[String]$TenantADName,
[Parameter(ParameterSetName='LoginByTenantID',Position=0,Mandatory=$true)]
[ValidateScript({
try
{
[System.Guid]::Parse($_) | Out-Null
$true
}
catch
{
$false
}
})]
[Alias('tID')]
[String]$TenantID,
[Parameter(ParameterSetName='LoginbyTenantADName',Position=1,Mandatory=$true)]
[Parameter(ParameterSetName='LoginByTenantID',Position=1,Mandatory=$true)]
[Alias('cred')]
[pscredential]
[System.Management.Automation.CredentialAttribute()]
$Credential
)
Try
{
If ($OMSConnection)
{
$Username = $OMSConnection.Username
$Password = $OMSConnection.Password
If ($OMSConnection.TenantID)
{
$TenantID = $OMSConnection.TenantID
}
Else
{
$TenantADName = $OMSConnection.TenantADName
}
}
Else
{
$Username = $Credential.Username
$Password = $Credential.Password
}
# Set well-known client ID for Azure PowerShell
$clientId = '1950a258-227b-4e31-a9cf-717495945fc2'
# Set Resource URI to Azure Service Management API
$resourceAppIdURI = 'https://management.azure.com/'
# Set Authority to Azure AD Tenant
If ($TenantID)
{
$authority = 'https://login.microsoftonline.com/common/' + $TenantID
}
Else
{
$authority = 'https://login.microsoftonline.com/' + $TenantADName
}
$AADcredential = New-Object `
-TypeName 'Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential' `
-ArgumentList $Username,$Password
# Create AuthenticationContext tied to Azure AD Tenant
$authContext = New-Object `
-TypeName 'Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext' `
-ArgumentList $authority
$authResult = $authContext.AcquireToken($resourceAppIdURI,$clientId,$AADcredential)
$Token = $authResult.CreateAuthorizationHeader()
}
Catch
{
$ErrorMessage = 'Failed to aquire Azure AD token.'
$ErrorMessage += " `n"
$ErrorMessage += 'Error: '
$ErrorMessage += $_
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
Return $Token
}
Function Get-OMSWorkspace {
<#
.SYNOPSIS
Get OMS Workspaces from Azure Subscription.
.DESCRIPTION
Get OMS Workspaces from Azure Subscription.
.PARAMETER Token
Token aquired from Get-AADToken cmdlet.
.PARAMETER SubscriptionID
Azure Subscription ID where the OMS workspace
is located.
.PARAMETER OMSConnection
Object that contains all needed parameters for working
with OMSSearch Module. You can create such object in
OMS Automation as connection asset.
.PARAMETER APIVersion
Api version for microsoft.operationalinsights
Azure Resource provider.
.EXAMPLE
Get-OMSWorkspace -SubscriptionId $Subscriptionid -Token $Token
Description
-----------
Gets all workspaces under Azure subscription by using Subscription ID
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$SubscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$Token = Get-AADToken -OMSConnection $OMSCon
.EXAMPLE
Get-OMSWorkspace -SubscriptionId $Subscriptionid -Token $Token -APIVersion '2015-03-20'
Description
-----------
Gets all workspaces under Azure subscription by using Subscription ID
Uses specific version of Operational Insights API
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$SubscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$Token = Get-AADToken -OMSConnection $OMSCon
.EXAMPLE
Get-OMSWorkspace -OMSConnection $OMSCon -Token $Token
Description
-----------
Gets all workspaces under Azure subscription by using information from asset of type connection in OMS Automation
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
.EXAMPLE
Get-OMSWorkspace -OMSConnection $OMSCon -Token $Token -APIVersion '2015-03-20'
Description
-----------
Gets all workspaces under Azure subscription by using information from asset of type connection in OMS Automation
Uses specific version of Operational Insights API
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
.OUTPUTS
System.Object. Returns array of objects. Each object
is OMS workspace information.
#>
[CmdletBinding(DefaultParameterSetName='DefaultParameterSet')]
[OutputType([object])]
PARAM (
[Parameter(ParameterSetName='DefaultParameterSet',Position=0,Mandatory=$true)]
[Parameter(ParameterSetName='OMSConnection',Position=0,Mandatory=$true)]
[String]$Token,
[Parameter(ParameterSetName='DefaultParameterSet',Position=1,Mandatory=$true)]
[ValidateScript({
try
{
[System.Guid]::Parse($_) | Out-Null
$true
}
catch
{
$false
}
})]
[string]$SubscriptionID,
[Parameter(ParameterSetName='OMSConnection',Position=1,Mandatory=$true)]
[Alias('Connection','c')]
[Object]$OMSConnection,
[Parameter(ParameterSetName='DefaultParameterSet',Position=2,Mandatory=$false)]
[Parameter(ParameterSetName='OMSConnection',Position=2,Mandatory=$false)]
[String]$APIVersion='2015-03-20'
)
Try
{
If ($OMSConnection)
{
$SubscriptionID = $OMSConnection.SubscriptionID
}
$URIManagement = 'https://management.azure.com'
$UriProvider = 'providers/microsoft.operationalinsights'
$OMSApiAction = 'workspaces'
$uri = '{0}/subscriptions/{1}/{2}/{3}?api-version={4}' `
-f $URIManagement,$SubscriptionID,$UriProvider,$OMSApiAction,$APIVersion
$headers = @{'Authorization'=$Token;'Accept'='application/json'}
$headers.Add('Content-Type','application/json')
$result = Invoke-WebRequest `
-Method Get `
-Uri $uri `
-Headers $headers `
-UseBasicParsing `
-ErrorAction Stop
}
Catch
{
$ErrorMessage = 'Failed to query OMS API. Check parameters.'
$ErrorMessage += " `n"
$ErrorMessage += 'Error: '
$ErrorMessage += $_
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
#region Verbose
$VerboseMessage = (Get-Date -Format HH:mm:ss).ToString() + ' - Web Request Status code: ' + $result.StatusCode
Write-Verbose `
-Message $VerboseMessage
#endregion
if($result.StatusCode -ge 200 -and $result.StatusCode -le 399)
{
if($null -ne $result.Content)
{
$json = ConvertFrom-Json `
-InputObject $result.Content `
-ErrorAction Stop
if($null -ne $json)
{
$return = $json
if($null -ne $json.value)
{
$return = $json.value
}
Else
{
$return = $null
}
}
Else
{
$return = $null
}
}
}
Else
{
$ErrorMessage = 'Failed to get OMS Workspace. Check parameters.'
$ErrorMessage += " `n"
$ErrorMessage += 'Web request Error: '
$ErrorMessage += $result
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
return $return
}
Function Get-OMSResourceGroup {
<#
.SYNOPSIS
Get Azure Resource Group where there is OMS
workspace resource.
The cmdlet assumes that your OMS resource Groups
has 'OI-Default-' in its name. This cmdlet is
scheduled to be depricated.
.DESCRIPTION
Get Azure Resource Group where there is OMS
workspace resource. The cmdlet assumes that your OMS resource Groups
has 'OI-Default-' in its name.
.PARAMETER Token
Token aquired from Get-AADToken cmdlet.
Token must be aquired with account that has
access to all resource groups in the Azure
subscription.
.PARAMETER SubscriptionID
Azure Subscription ID where the OMS workspace
is located.
.PARAMETER OMSConnection
Object that contains all needed parameters for working
with OMSSearch Module. You can create such object in
OMS Automation as connection asset.
.PARAMETER APIVersion
Api version for Azure subscriptions provider.
.EXAMPLE
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$SubscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$Token = Get-AADToken -OMSConnection $OMSCon
Get-OMSResourceGroup -SubscriptionId $Subscriptionid -Token $Token
.EXAMPLE
$SubscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$Token = Get-AADToken -OMSConnection $OMSCon
Get-OMSResourceGroup -SubscriptionId $Subscriptionid -Token $Token -APIVersion '2014-04-01'
.EXAMPLE
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
Get-OMSResourceGroup -OMSConnection $OMSCon -Token $Token
.EXAMPLE
$Token = Get-AADToken -OMSConnection $OMSCon
Get-OMSResourceGroup -OMSConnection $OMSCon -Token $Token -APIVersion '2014-04-01'
.OUTPUTS
System.Object. Returns array of objects. Each object
is OMS resoure group information.
#>
[CmdletBinding(DefaultParameterSetName='DefaultParameterSet')]
[OutputType([object[]])]
PARAM (
[Parameter(ParameterSetName='DefaultParameterSet',Position=0,Mandatory=$true)]
[Parameter(ParameterSetName='OMSConnection',Position=0,Mandatory=$true)]
[String]$Token,
[Parameter(ParameterSetName='DefaultParameterSet',Position=1,Mandatory=$true)]
[ValidateScript({
try
{
[System.Guid]::Parse($_) | Out-Null
$true
}
catch
{
$false
}
})]
[string]$SubscriptionID,
[Parameter(ParameterSetName='OMSConnection',Position=1,Mandatory=$true)]
[Alias('Connection','c')]
[Object]$OMSConnection,
[Parameter(ParameterSetName='DefaultParameterSet',Position=2,Mandatory=$false)]
[Parameter(ParameterSetName='OMSConnection',Position=2,Mandatory=$false)]
[String]$APIVersion='2014-04-01'
)
Try
{
If ($OMSConnection)
{
$SubscriptionID = $OMSConnection.SubscriptionID
}
#region Warning
$WarningMessage = 'This cmdlet returns OMS resource groups that have OI-Default- in its name. This cmdlet is scheduled to be depricated.'
Write-Warning `
-Message $WarningMessage
#endregion
$URIManagement = 'https://management.azure.com'
$OMSApiAction = 'resourceGroups'
$uri = '{0}/subscriptions/{1}/{2}?api-version={3}' `
-f $URIManagement,$SubscriptionID,$OMSApiAction,$APIVersion
$headers = @{'Authorization'=$Token;'Accept'='application/json'}
$headers.Add('Content-Type','application/json')
$result = Invoke-WebRequest `
-Method Get `
-Uri $uri `
-Headers $headers `
-UseBasicParsing `
-ErrorAction Stop
}
Catch
{
$ErrorMessage = 'Failed to query Azure Resource Manager API. Check parameters.'
$ErrorMessage += " `n"
$ErrorMessage += 'Error: '
$ErrorMessage += $_
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
#region Verbose
$VerboseMessage = (Get-Date -Format HH:mm:ss).ToString() + ' - Web Request Status code: ' + $result.StatusCode
Write-Verbose `
-Message $VerboseMessage
#endergion
if($result.StatusCode -ge 200 -and $result.StatusCode -le 399)
{
if($null -ne $result.Content)
{
$json = ConvertFrom-Json `
-InputObject $result.Content `
-ErrorAction Stop
if($null -ne $json)
{
$return = $json
if($null -ne $json.value)
{
$return = $json.value
}
Else
{
$return = $null
}
}
Else
{
$return = $null
}
}
}
Else
{
$ErrorMessage = 'Failed to get OMS Resource Group. Check parameters.'
$ErrorMessage += " `n"
$ErrorMessage += 'Web request Error: '
$ErrorMessage += $result
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
#Filter out all none OMS resource groups
$arrOMSResourceGroups = @()
If ($null -ne $return)
{
Foreach ($resourceGroup in $return)
{
if ($resourceGroup.name -imatch '^OI-Default-')
{
$arrOMSResourceGroups += $resourceGroup
}
}
}
#region Verbose
$VerboseMessage = (Get-Date -Format HH:mm:ss).ToString() + 'Total OMS resource groups found: ' + $arrOMSResourceGroups.count
Write-Verbose `
-Message $VerboseMessage
#endergion
return $arrOMSResourceGroups
}
Function Get-OMSSavedSearch {
<#
.SYNOPSIS
Gets Saved Searches from OMS workspace
.DESCRIPTION
Gets Saved Searches from OMS workspace
.PARAMETER Token
Token aquired from Get-AADToken cmdlet.
.PARAMETER SubscriptionID
Azure Subscription ID where the OMS workspace
is located.
.PARAMETER ResourceGroupName
Azure Resource Group Name where the OMS
workspace is located.
.PARAMETER OMSWorkspaceName
Name of the OMS workspace.
.PARAMETER OMSConnection
Object that contains all needed parameters for working
with OMSSearch Module. You can create such object in
OMS Automation as connection asset.
.PARAMETER QueryName
Specify the full name of OMS Saved Search to get
only specific query. Array of saved search names
can be specified as well.
.PARAMETER APIVersion
Api version for microsoft.operationalinsights
Azure Resource provider.
.EXAMPLE
$OMSSS=Get-OMSSavedSearch -SubscriptionID $subscriptionId -ResourceGroupName $ResourceGroupName -OMSWorkspaceName $OMSWorkspace -Token $Token
Description
-----------
Gets Saved Searches from OMS
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
$subscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$ResourceGroupName = "oi-default-east-us"
$OMSWorkspace = "Test"
Example Output
--------------
$OMSSS[0].ID
$OMSSS[0].etag
$OMSSS[0].properties
$OMSSS[0].properties.Category
$OMSSS[0].properties.DisplayName
$OMSSS[0].properties.Query
$OMSSS[0].properties.Version
.EXAMPLE
$OMSSS=Get-OMSSavedSearch -SubscriptionID $subscriptionId -ResourceGroupName $ResourceGroupName -OMSWorkspaceName $OMSWorkspace -Token $Token -APIVersion '2015-03-20'
Description
-----------
Gets Saved Searches from OMS.
Uses specific version of Operational Insights API
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
$subscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$ResourceGroupName = "oi-default-east-us"
$OMSWorkspace = "Test"
Example Output
--------------
$OMSSS[0].ID
$OMSSS[0].etag
$OMSSS[0].properties
$OMSSS[0].properties.Category
$OMSSS[0].properties.DisplayName
$OMSSS[0].properties.Query
$OMSSS[0].properties.Version
.EXAMPLE
$OMSSS = Get-OMSSavedSearch -OMSConnection $OMSCon -Token $Token
Description
-----------
Gets Saved Searches from OMS by using information from asset of type connection in OMS Automation
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
Example Output
--------------
$OMSSS[0].ID
$OMSSS[0].etag
$OMSSS[0].properties
$OMSSS[0].properties.Category
$OMSSS[0].properties.DisplayName
$OMSSS[0].properties.Query
$OMSSS[0].properties.Version
.EXAMPLE
$OMSSS = Get-OMSSavedSearch -OMSConnection $OMSCon -Token $Token -QueryName 'SavedQueryName'
Description
-----------
Gets specific Saved Search from OMS by using information from asset of type connection in OMS Automation
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
Example Output
--------------
$OMSSS[0].ID
$OMSSS[0].etag
$OMSSS[0].properties
$OMSSS[0].properties.Category
$OMSSS[0].properties.DisplayName
$OMSSS[0].properties.Query
$OMSSS[0].properties.Version
.EXAMPLE
$OMSSS = Get-OMSSavedSearch -OMSConnection $OMSCon -Token $Token -QueryName 'SavedQueryName1','SavedQueryName2'
Description
-----------
Gets specific Saved Searches from OMS by using information from asset of type connection in OMS Automation
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
Example Output
--------------
$OMSSS[0].ID
$OMSSS[0].etag
$OMSSS[0].properties
$OMSSS[0].properties.Category
$OMSSS[0].properties.DisplayName
$OMSSS[0].properties.Query
$OMSSS[0].properties.Version
.OUTPUTS
System.Object. Returns array of objects. Each object
is saved search query. If no saved searches are found
error is returned.
#>
[CmdletBinding(DefaultParameterSetName='DefaultParameterSet')]
[OutputType([object])]
PARAM (
[Parameter(ParameterSetName='OMSConnection',Position=0,Mandatory=$true)]
[Parameter(ParameterSetName='DefaultParameterSet',Position=0,Mandatory=$true)]
[String]$Token,
[Parameter(ParameterSetName='DefaultParameterSet',Position=1,Mandatory=$true)]
[ValidateScript({
try
{
[System.Guid]::Parse($_) | Out-Null
$true
}
catch
{
$false
}
})]
[string]$SubscriptionID,
[Parameter(ParameterSetName='DefaultParameterSet',Position=2,Mandatory=$true)]
[String]$ResourceGroupName,
[Parameter(ParameterSetName='DefaultParameterSet',Position=3,Mandatory=$true)]
[String]$OMSWorkspaceName,
[Parameter(ParameterSetName='OMSConnection',Position=2,Mandatory=$true)]
[Alias('Connection','c')]
[Object]$OMSConnection,
[Parameter(ParameterSetName='DefaultParameterSet',Position=4,Mandatory=$false)]
[Parameter(ParameterSetName='OMSConnection',Position=4,Mandatory=$false)]
[String[]]$QueryName=$null,
[Parameter(ParameterSetName='DefaultParameterSet',Position=4,Mandatory=$false)]
[Parameter(ParameterSetName='OMSConnection',Position=4,Mandatory=$false)]
[String]$APIVersion='2015-03-20'
)
Try
{
If ($OMSConnection)
{
$SubscriptionID = $OMSConnection.SubscriptionID
$ResourceGroupName = $OMSConnection.ResourceGroupName
$OMSWorkspaceName = $OMSConnection.WorkSpaceName
}
$URIManagement = 'https://management.azure.com'
$UriProvider = 'providers/microsoft.operationalinsights'
$OMSApiAction = 'savedSearches'
$uri = '{0}/subscriptions/{1}/resourcegroups/{2}/{3}/workspaces/{4}/{5}?api-version={6}' `
-f $URIManagement,$SubscriptionID, $ResourceGroupName, $UriProvider, $OMSWorkspaceName,$OMSApiAction, $APIVersion
$headers = @{'Authorization'=$Token;'Accept'='application/json'}
$headers.Add('Content-Type','application/json')
$result = Invoke-WebRequest `
-Method Get `
-Uri $uri `
-Headers $headers `
-UseBasicParsing `
-ErrorAction Stop
}
Catch
{
$ErrorMessage = 'Failed to query OMS API.'
$ErrorMessage += " `n"
$ErrorMessage += 'Error: '
$ErrorMessage += $_
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
#region Verbose
$VerboseMessage = (Get-Date -Format HH:mm:ss).ToString() + ' - Web Request Status code: ' + $result.StatusCode
Write-Verbose `
-Message $VerboseMessage
#endregion
if ($result.StatusCode -ge 200 -and $result.StatusCode -le 399)
{
if ($null -ne $result.Content)
{
$json = ConvertFrom-Json `
-InputObject $result.Content `
-ErrorAction Stop
if ($null -ne $json)
{
$OMSSavedSearches = $json
$return = $json
if ($null -ne $json.value)
{
$OMSSavedSearches = $json.value
$return = $json.value
}
Else
{
$ErrorMessage = 'There are no OMS Saved Searches.'
$ErrorMessage += " `n"
$ErrorMessage += 'Returned results: '
$ErrorMessage += $json
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
}
Else
{
$ErrorMessage = 'There are no OMS Saved Searches.'
$ErrorMessage += " `n"
$ErrorMessage += 'Returned results: '
$ErrorMessage += $json
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
}
}
Else
{
$ErrorMessage = 'Failed to get OMS Saved Searches.'
$ErrorMessage += " `n"
$ErrorMessage += 'Web request Error: '
$ErrorMessage += $result
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
}
# If Name parameter specified
If ($QueryName)
{
$match = $false
$QueriesArray = @()
foreach ($qName in $QueryName)
{
foreach($q in $OMSSavedSearches)
{
if ($q.properties.displayname.Tostring() -eq $qName)
{
$QueriesArray += $q
$match=$true;break;
}
}
if(! $match)
{
$ErrorMessage = 'Failed to find query with Name: ' + $qName
$ErrorMessage += " `n"
$ErrorMessage += 'Error: '
$ErrorMessage += $_
Write-Error -Message $ErrorMessage `
-ErrorAction Stop
return $null
}
else
{
$return = $QueriesArray
}
}
}
return $return
}
Function Remove-OMSSavedSearch {
<#
.SYNOPSIS
Deletes OMS Saved Search.
.DESCRIPTION
Deletes OMS Saved Search. Deleted saved search
does not immediately dissappears from OMS portal.
It may take a couple of minutes until it dissappears.
.PARAMETER Token
Token aquired from Get-AADToken cmdlet.
.PARAMETER SubscriptionID
Azure Subscription ID where the OMS workspace
is located.
.PARAMETER ResourceGroupName
Azure Resource Group Name where the OMS
workspace is located.
.PARAMETER OMSWorkspaceName
Name of the OMS workspace.
.PARAMETER OMSConnection
Object that contains all needed parameters for working
with OMSSearch Module. You can create such object in
OMS Automation as connection asset.
.PARAMETER QueryName
Specify the full name of OMS Saved Search to get
only specific query.
.PARAMETER APIVersion
Api version for microsoft.operationalinsights
Azure Resource provider.
.EXAMPLE
Remove-OMSSavedSearch -SubscriptionID $subscriptionId -ResourceGroupName $ResourceGroupName -OMSWorkspaceName $OMSWorkspace -Token $Token -QueryName 'SavedQueryName'
Description
-----------
Removes specific Saved Search by name from OMS
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
$subscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$ResourceGroupName = "oi-default-east-us"
$OMSWorkspace = "Test"
.EXAMPLE
Remove-OMSSavedSearch -SubscriptionID $subscriptionId -ResourceGroupName $ResourceGroupName -OMSWorkspaceName $OMSWorkspace -Token $Token -QueryName 'SavedQueryName' -APIVersion '2015-03-20'
Description
-----------
Removes specific Saved Search by name from OMS
Uses specific version of Operational Insights API
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
$subscriptionId = "3c1d68a5-4064-4522-94e4-e0378165555e"
$ResourceGroupName = "oi-default-east-us"
$OMSWorkspace = "Test"
.EXAMPLE
Remove-OMSSavedSearch -OMSConnection $OMSCon -Token $Token -QueryName 'SavedQueryName'
Description
-----------
Removes specific Saved Search by name from OMS by using information from asset of type connection in OMS Automation
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
.EXAMPLE
Remove-OMSSavedSearch -OMSConnection $OMSCon -Token $Token -QueryName 'SavedQueryName' -APIVersion '2015-03-20'
Description
-----------
Removes specific Saved Search by name from OMS by using information from asset of type connection in OMS Automation
Uses specific version of Operational Insights API
Example Variables
-----------------
$OMSCon = Get-AutomationConnection -Name 'OMSCon'
$Token = Get-AADToken -OMSConnection $OMSCon
.OUTPUTS
No Output.
]
#>
[CmdletBinding(DefaultParameterSetName='DefaultParameterSet')]
[OutputType([object])]
PARAM (
[Parameter(ParameterSetName='DefaultParameterSet',Position=0,Mandatory=$true)]
[Parameter(ParameterSetName='OMSConnection',Position=0,Mandatory=$true)]
[String]$Token,
[Parameter(ParameterSetName='OMSConnection',Position=1,Mandatory=$true)]
[Alias('Connection','c')]
[Object]$OMSConnection,
[Parameter(ParameterSetName='DefaultParameterSet',Position=1,Mandatory=$true)]
[ValidateScript({
try
{
[System.Guid]::Parse($_) | Out-Null
$true
}
catch
{
$false
}
})]
[string]$SubscriptionID,
[Parameter(ParameterSetName='DefaultParameterSet',Position=2,Mandatory=$true)]
[String]$ResourceGroupName,
[Parameter(ParameterSetName='DefaultParameterSet',Position=3,Mandatory=$true)]
[String]$OMSWorkspaceName,
[Parameter(ParameterSetName='DefaultParameterSet',Position=4,Mandatory=$true)]
[Parameter(ParameterSetName='OMSConnection',Position=4,Mandatory=$true)]
[String]$QueryName,
[Parameter(ParameterSetName='DefaultParameterSet',Position=5,Mandatory=$false)]
[Parameter(ParameterSetName='OMSConnection',Position=5,Mandatory=$false)]
[String]$APIVersion='2015-03-20'
)
Try
{