Powershell Cmdlets for Alerts Management #9495

mahakjain314 · 2019-06-25T00:01:25Z

Description

This feature enables customers to perform the operations supported by AlertsManagement RP on alerts, action rule and smart groups through Powershell.
Design Review - https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues/315

Checklist

I have read the Submitting Changes section of CONTRIBUTING.md
The title of the PR is clear and informative
The appropriate change log has been updated
The PR does not introduce breaking changes
If applicable, the changes made in the PR have proper test coverage
For public API changes to cmdlets:
- the changes have gone through a cmdlet design review (Microsoft internal partners only)
- the cmdlet markdown files were generated using the platyPS module

adxsdkps · 2019-06-25T00:01:28Z

Can one of the admins verify this patch?

…hell

markcowl

Soem review comments - also, there appears to be a build failure

src/AlertsManagement/AlertsManagement/ActionRuleCommands/GetAzureActionRule.cs

src/AlertsManagement/AlertsManagement/ActionRuleCommands/RemoveAzureActionRule.cs

src/AlertsManagement/AlertsManagement/ActionRuleCommands/GetAzureActionRule.cs

src/AlertsManagement/AlertsManagement/ActionRuleCommands/RemoveAzureActionRule.cs

src/AlertsManagement/AlertsManagement/AlertCommands/UpdateAzureAlertState.cs

src/AlertsManagement/AlertsManagement/AlertsManagement.csproj

src/AlertsManagement/AlertsManagement/AlertsManagementBaseCmdlet.cs

src/AlertsManagement/documentation/current-breaking-changes.md

src/AlertsManagement/AlertsManagement/help/Update-AzSmartGroupState.md

mahakjain314 · 2019-06-26T21:11:12Z

@markcowl I have few queries -

Is taking Json input for complex properties recommended or I should always break it down to simple parameters or both?
The build is failing because - "The online version in help file is incorrect". How do I go about it?
Is WriteInformation() correct way to convey information like - successful deletion etc.?
What is the correct way to skip writing the properties which are null?
How to deal with paging when we have huge data? Any way to display data in pages?

…sets

src/AlertsManagement/AlertsManagement/help/Az.AlertsManagement.md

markcowl · 2019-07-12T18:12:59Z

@mahakjain314 I identified the issue you are having in the analysis runs, and the security-tools issue is just that you need to check the issues it identified and suppress them if they are not existing credentials

Please let us know if you have any questions

mahakjain314 · 2019-07-15T18:14:31Z

Few questions -
Is the a way to skip a particular property while displaying the output model when it is null or empty? For example - In PSActionRule, SuppressionConfig and ActionGroupId will not be populated together. They are mutually exclusive. Is there a way to deal with such cases?

markcowl

Well, the number of issues are getting smaller every time, so progress

src/AlertsManagement/AlertsManagement/ActionRuleCommands/GetAzureActionRule.cs

src/AlertsManagement/AlertsManagement/ActionRuleCommands/SetAzureActionRule.cs

markcowl · 2019-07-16T00:11:15Z

src/AlertsManagement/AlertsManagement/ActionRuleCommands/SetAzureActionRule.cs

+        [Parameter(Mandatory = false,
+                ParameterSetName = BySimplifiedFormatDiagnosticsActionRuleParameterSet,
+                HelpMessage = "Description of Action Rule")]
+        public string Description { get; set; }


This parameter must be in the InputObject poarameter set - when someone supplies an InputObject, they should be able to override any particular property using the parameters. This enables scenarios like:

Get-AzActionRule | Select {...} | Set-AzActionRule -Status Disabled

This is explicitly called out in the sample Set cmdlet here: https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/examples/set-cmdlet-example.md although it is fine to simply use the passed-in object and override its properties with the specified ones.

src/AlertsManagement/AlertsManagement/ActionRuleCommands/UpdateAzureActionRule.cs

markcowl · 2019-07-16T00:26:33Z

src/AlertsManagement/AlertsManagement/AlertCommands/GetAzureAlert.cs

+        [Parameter(Mandatory = false,
+                   ParameterSetName = AlertsListByTargetResourceGroupFilterParameterSet,
+                   HelpMessage = "Filter on Moniter Service")]
+        [Parameter(Mandatory = false,


Simplification note for the future (not a required change now) Optional parameters that occur in every parameter set just need a single parameter attribute with no parametersetname

Sure. I'll prefer mentioning explicitly initially to avoid confusion.

markcowl · 2019-07-16T00:35:25Z

src/AlertsManagement/AlertsManagement/AlertCommands/GetAzureAlert.cs

+        [Parameter(Mandatory = false,
+                   ParameterSetName = AlertsListByTargetResourceGroupFilterParameterSet,
+                   HelpMessage = "Include EgressConfig - true/false")]
+        public bool IncludeEgressConfig { get; set; }


See my above response. InputObject parameter set for Set cmdlets should include all the non-identity parameters. This allows a user to override proeprties of an input object in piping scenarios.

src/AlertsManagement/AlertsManagement/AlertCommands/MeasureAzureAlertStatistic.cs

src/AlertsManagement/AlertsManagement/AlertsManagementBaseCmdlet.cs

src/AlertsManagement/AlertsManagement/ChangeLog.md

markcowl · 2019-07-22T22:00:46Z

/azp run azure-powershell - powershell-core

azure-pipelines · 2019-07-22T22:00:56Z

Azure Pipelines successfully started running 1 pipeline(s).

markcowl · 2019-07-22T22:11:50Z

src/AlertsManagement/AlertsManagement/ActionRuleCommands/SetAzureActionRule.cs

+        [Parameter(Mandatory = false,
+                ParameterSetName = BySimplifiedFormatDiagnosticsActionRuleParameterSet,
+                HelpMessage = "Description of Action Rule")]
+        public string Description { get; set; }


This change is deferred until GA

markcowl · 2019-07-22T22:12:06Z

src/AlertsManagement/AlertsManagement/ActionRuleCommands/SetAzureActionRule.cs

+                HelpMessage = "Status of Action Rule.")]
+        [ValidateNotNullOrEmpty]
+        [PSArgumentCompleter("Enabled", "Disabled")]
+        public string Status { get; set; }


This change is deferred until GA

markcowl · 2019-07-22T22:13:47Z

src/AlertsManagement/AlertsManagement/ActionRuleCommands/UpdateAzureActionRule.cs

+        [Parameter(ParameterSetName = ByInputObjectParameterSet, Mandatory = false, HelpMessage = "Action rule status")]
+        [Parameter(ParameterSetName = ByNameSimplifiedPatchParameterSet, Mandatory = false, HelpMessage = "Action rule status")]
+        [PSArgumentCompleter(ActionRuleStatus.Enabled, ActionRuleStatus.Disabled)]
+        public string Status { get; set; }


For future reference: this should be split into Enable/Disable cmdlets, since there is no other function of the update cmdlet.

markcowl · 2019-07-22T22:15:11Z

src/AlertsManagement/AlertsManagement/AlertCommands/GetAzureAlert.cs

+        [Parameter(Mandatory = false,
+                   ParameterSetName = AlertsListByTargetResourceGroupFilterParameterSet,
+                   HelpMessage = "Include EgressConfig - true/false")]
+        public bool IncludeEgressConfig { get; set; }


This needs to be updated for GA

Mahak Jain added 7 commits June 13, 2019 21:00

Initial implementation and project setup

7ccdc65

Implemented Action Rule Commands

1d17833

Merge branch 'master' of https://github.com/Azure/azure-powershell

1adc706

Initial Implementation for Tests

9c8dfcd

Updated Tests for Alerts and Smart Groups

e5734b5

Implemeneted InputObject and ResourceId parameter sets

7e41567

Updated session records for Scenario Tests

fee90f6

Minor fixes

26aa993

azuresdkci added the needs-review label Jun 25, 2019

Mahak Jain added 2 commits June 25, 2019 20:43

Added help-generation and change.log files

d1fe1a0

Merge branch 'master' of https://github.com/mahakjain314/azure-powers…

6aaecb0

…hell

cormacpayne assigned markcowl Jun 25, 2019

Mahak Jain added 5 commits June 26, 2019 00:34

Updated published version of Nuget package for AlertsManagement SDK

d3668d0

Updated ActionRule Scenario Tests

dc22f85

Merge branch 'master' of https://github.com/mahakjain314/azure-powers…

69bf4f7

…hell

Update Set action rule

17ee8fe

Fix for Set Action Rule

27373ef

markcowl requested changes Jun 26, 2019

View reviewed changes

markcowl assigned mahakjain314 and unassigned markcowl Jun 26, 2019

markcowl added needs-revision and removed needs-review labels Jun 26, 2019

Mahak Jain added 2 commits June 27, 2019 02:03

Updated the help generation files

8e72749

Updated online version in help generation files

971bb44

Mahak Jain added 4 commits June 27, 2019 21:00

Resolve PR comments

b9d3553

Updated failing tests

8dc92be

Updated the default parameter set for cmdlets with multiple paramter …

487448a

…sets

Implemented InputObject Parameter for Get-History cmdlets

53641cf

markcowl added the needs-revision label Jul 5, 2019

Mahak Jain added 4 commits July 9, 2019 21:24

Resolve PR comments

e0a4511

Resolve PR comments

cfb174f

Updated Tests

ee4a412

Deal with paging parameters

eb2607a

markcowl requested changes Jul 12, 2019

View reviewed changes

src/AlertsManagement/AlertsManagement/help/Az.AlertsManagement.md Outdated Show resolved Hide resolved

Mahak Jain added 4 commits July 13, 2019 00:29

Fix static analysis error

be04c36

Moved customer facing strinsg to resources

8bba930

Update Help files

77d47cd

Enrich information for Action Rule

35ef33c

markcowl requested changes Jul 16, 2019

View reviewed changes

Mahak Jain added 8 commits July 16, 2019 20:26

Determine Scope Type programatically

9d9bd7b

Generate Ps1xml format

1e54d3b

Display ActionRule based on Type

6a249f4

Updated Encoding of Data file

23f552b

Created table format as default view

dda8042

Resolve PR comments

76bba32

Updated parameter set for Get operations to make them mutually exclusive

f869685

Removed artifact dependency

5bdf31c

mahakjain314 added needs-review and removed needs-revision labels Jul 19, 2019

markcowl approved these changes Jul 22, 2019

View reviewed changes

markcowl added Waiting for CI and removed needs-review labels Jul 22, 2019

markcowl unassigned mahakjain314 Jul 22, 2019

markcowl merged commit cb0c1c4 into Azure:master Jul 23, 2019

Powershell Cmdlets for Alerts Management #9495

Powershell Cmdlets for Alerts Management #9495

Uh oh!

Conversation

mahakjain314 commented Jun 25, 2019

Description

Checklist

Uh oh!

adxsdkps commented Jun 25, 2019

Uh oh!

markcowl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mahakjain314 commented Jun 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

markcowl commented Jul 12, 2019

Uh oh!

mahakjain314 commented Jul 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markcowl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markcowl commented Jul 22, 2019

Uh oh!

azure-pipelines bot commented Jul 22, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mahakjain314 commented Jun 26, 2019 •

edited

Loading

mahakjain314 commented Jul 15, 2019 •

edited

Loading