Skip to content

Update helpers with explanations & examples #17841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 43 commits into from
Apr 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
a1aa7d9
add models
surashed Mar 29, 2022
e432611
minor changes on the Automation Models
surashed Mar 29, 2022
5ecb5e4
add models converters
surashed Mar 29, 2022
2509d3c
changes
surashed Mar 29, 2022
635708b
changes
surashed Mar 29, 2022
ea88ef1
changes
surashed Mar 29, 2022
466b7a7
changes
surashed Mar 30, 2022
6feaaed
changes
surashed Mar 31, 2022
a51e9d4
fix
surashed Mar 31, 2022
e5be276
Get-AzSecurityAutomation fixes
surashed Mar 31, 2022
de3725f
changes
surashed Mar 31, 2022
aae04a0
changes
surashed Mar 31, 2022
60213a5
changes
surashed Mar 31, 2022
f68316a
changes
surashed Mar 31, 2022
c2ba2ab
update help files
surashed Mar 31, 2022
28e48e6
changes
surashed Mar 31, 2022
355142c
Add testing for Automations cmdlets
surashed Apr 3, 2022
c842f2f
align SecurityAutomationTests.ps1
surashed Apr 3, 2022
6bbe8b3
minor fix
surashed Apr 3, 2022
0bc981e
Add Automations tests recording
surashed Apr 3, 2022
d2b1b6b
Add changes description to ChangeLog.md
surashed Apr 3, 2022
2c2e1e6
changes
surashed Apr 7, 2022
73f2566
Add help commands
surashed Apr 7, 2022
908b311
Add help commands
surashed Apr 7, 2022
925d6c8
Add help commands
surashed Apr 7, 2022
880b790
minor alignments on security test
surashed Apr 7, 2022
8cd53ab
minor fixes
surashed Apr 7, 2022
b39d7f6
update tests
surashed Apr 7, 2022
1c3f344
a
surashed Apr 7, 2022
58102fb
update
surashed Apr 7, 2022
49a95d9
update
surashed Apr 7, 2022
122df0d
changee
surashed Apr 12, 2022
57dc607
update tests
surashed Apr 12, 2022
159e336
update tests
surashed Apr 12, 2022
4f41f54
update tests
surashed Apr 12, 2022
4710c07
renaming
surashed Apr 14, 2022
8a4c754
Align AzSecurityAutomation helper function names
surashed Apr 14, 2022
bbb6bd2
fix test
surashed Apr 14, 2022
dca2cef
updates
surashed Apr 14, 2022
8f31016
Update SignatureIssues.csv
surashed Apr 14, 2022
c4fdbbf
update heloers with explanations & examples
surashed Apr 18, 2022
fca64bb
merge with upstream/main
surashed Apr 18, 2022
43bed1b
minor fixes
surashed Apr 18, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions src/Security/Security/help/Az.Security.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Enforces the given rules on the NSG(s) listed in the request
Add SQL vulnerability assessment baseline.

### [Confirm-AzSecurityAutomation](Confirm-AzSecurityAutomation.md)
{{ Fill in the Synopsis }}
Validates the security automation model before create or update. Any validation errors are returned to the client

### [Disable-AzIotSecurityAnalyticsAggregatedAlert](Disable-AzIotSecurityAnalyticsAggregatedAlert.md)
Dismiss Iot aggregated alert
Expand Down Expand Up @@ -87,7 +87,7 @@ Gets security assessments and their results on a subscription
Gets security assessments types and metadta in a subscription.

### [Get-AzSecurityAutomation](Get-AzSecurityAutomation.md)
{{ Fill in the Synopsis }}
Gets security automation(s)

### [Get-AzSecurityAutoProvisioningSetting](Get-AzSecurityAutoProvisioningSetting.md)
Gets the security automatic provisioning settings
Expand Down Expand Up @@ -159,7 +159,22 @@ Create new recommendation configuration for iot security solution
Create new user defined resources for iot security solution

### [New-AzSecurityAutomation](New-AzSecurityAutomation.md)
{{ Fill in the Synopsis }}
Creates new security automation

### [New-AzSecurityAutomationActionObject](New-AzSecurityAutomationActionObject.md)
Creates new security automation action object

### [New-AzSecurityAutomationRuleObject](New-AzSecurityAutomationRuleObject.md)
Creates new security automation rule object

### [New-AzSecurityAutomationRuleSetObject](New-AzSecurityAutomationRuleSetObject.md)
Creates new security automation rule set object

### [New-AzSecurityAutomationScopeObject](New-AzSecurityAutomationScopeObject.md)
Creates new security automation scope object

### [New-AzSecurityAutomationSourceObject](New-AzSecurityAutomationSourceObject.md)
Creates new security automation source object

### [Remove-AzDeviceSecurityGroup](Remove-AzDeviceSecurityGroup.md)
Delete device security group
Expand All @@ -177,7 +192,7 @@ Deletes a security assessment result from a subscription.
Deletes a security assessment metadata from a subscription.

### [Remove-AzSecurityAutomation](Remove-AzSecurityAutomation.md)
{{ Fill in the Synopsis }}
Deletes security automation

### [Remove-AzSecurityContact](Remove-AzSecurityContact.md)
Deletes a security contact.
Expand Down
8 changes: 4 additions & 4 deletions src/Security/Security/help/Confirm-AzSecurityAutomation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Confirm-AzSecurityAutomation

## SYNOPSIS
{{ Fill in the Synopsis }}
Validates the security automation model before create or update. Any validation errors are returned to the client

## SYNTAX

Expand Down Expand Up @@ -37,16 +37,16 @@ Confirm-AzSecurityAutomation [-Location <String>] [-Etag <String>] [-Tag <Hashta
```

## DESCRIPTION
{{ Fill in the Description }}
Validates the security automation model before create or update. Any validation errors are returned to the client

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> Confirm-AzSecurityAutomation -Name 'SampleAutomation' -ResourceGroupName 'SampleResourceGroup' -Description 'Sample security automation' -Scope $scopes -Source $sources -Action $actions
```

{{ Add example description here }}
Validates that the creation of security automation named "SampleAutomation" under resource group named "SampleResourceGroup"

## PARAMETERS

Expand Down
8 changes: 4 additions & 4 deletions src/Security/Security/help/Get-AzSecurityAutomation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzSecurityAutomation

## SYNOPSIS
{{ Fill in the Synopsis }}
Gets security automations

## SYNTAX

Expand All @@ -35,16 +35,16 @@ Get-AzSecurityAutomation -ResourceId <String> [-DefaultProfile <IAzureContextCon
```

## DESCRIPTION
{{ Fill in the Description }}
Gets security automations

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> Get-AzSecurityAutomation
```

{{ Add example description here }}
Gets all security automations under the subscription

## PARAMETERS

Expand Down
8 changes: 4 additions & 4 deletions src/Security/Security/help/New-AzSecurityAutomation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzSecurityAutomation

## SYNOPSIS
{{ Fill in the Synopsis }}
Creates new security automation

## SYNTAX

Expand Down Expand Up @@ -37,16 +37,16 @@ New-AzSecurityAutomation [-Location <String>] [-Etag <String>] [-Tag <Hashtable>
```

## DESCRIPTION
{{ Fill in the Description }}
Creates new security automation

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> New-AzSecurityAutomation -Name 'ampleAutomation' -ResourceGroupName 'SampleResourceGroup' -Description 'Sample security automation' -Scope $scopes -Source $sources -Action $actions
```

{{ Add example description here }}
Creates new security automation named "SampleAutomation" under resource group named "SampleResourceGroup"

## PARAMETERS

Expand Down
22 changes: 18 additions & 4 deletions src/Security/Security/help/New-AzSecurityAutomationActionObject.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzSecurityAutomationActionObject

## SYNOPSIS
{{ Fill in the Synopsis }}
Creates new security automation action object

## SYNTAX

Expand All @@ -31,16 +31,30 @@ New-AzSecurityAutomationActionObject -WorkspaceResourceId <String> [-DefaultProf
```

## DESCRIPTION
{{ Fill in the Description }}
Creates new security automation action object

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> New-AzSecurityAutomationActionObject -WorkspaceResourceId '/subscriptions/64ac75e7-15ff-4963-8c07-a16016505e0f/resourceGroups/sampleResourceGroup/providers/Microsoft.OperationalInsights/workspaces/surashed-test'
```

{{ Add example description here }}
Creates new security automation action with workspace type

### Example 2
```powershell
PS C:\> New-AzSecurityAutomationActionObject -LogicAppResourceId '/subscriptions/03b601f1-7eca-4496-8f8d-355219eee254/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/workflows/LA' -Uri 'https://dummy.com/'
```

Creates new security automation action with logicApp type

### Example 3
```powershell
PS C:\> New-AzSecurityAutomationActionObject -EventHubResourceId 'subscriptions/03b601f1-7eca-4496-8f8d-355219eee254/resourceGroups/sampleResourceGroup/providers/Microsoft.EventHub/namespaces/cus-wsp-fake-assessment/eventhubs/cus-wsp-fake-assessment' -ConnectionString 'Endpoint=sb://dummy/;SharedAccessKeyName=dummy;SharedAccessKey=dummy;EntityPath=dummy'
```

Creates new security automation action with even-hub type

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzSecurityAutomationRuleObject

## SYNOPSIS
{{ Fill in the Synopsis }}
Creates security automation rule object

## SYNTAX

Expand All @@ -18,16 +18,16 @@ New-AzSecurityAutomationRuleObject -PropertyJPath <String> -Operator <String> -E
```

## DESCRIPTION
{{ Fill in the Description }}
Creates security automation rule object

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> New-AzSecurityAutomationRuleObject -PropertyJPath 'properties.metadata.severity' -PropertyType 'String' -Operator 'Equals' -ExpectedValue 'High'
```

{{ Add example description here }}
Creates security automation rule object that filters messages that with "High" severity

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzSecurityAutomationRuleSetObject

## SYNOPSIS
{{ Fill in the Synopsis }}
Creates security automation rule set object

## SYNTAX

Expand All @@ -18,16 +18,16 @@ New-AzSecurityAutomationRuleSetObject -Rules <PSSecurityAutomationTriggeringRule
```

## DESCRIPTION
{{ Fill in the Description }}
Creates security automation rule set object

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> New-AzSecurityAutomationRuleSetObject -Rule $rule
```

{{ Add example description here }}
Creates security automation rule set object

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzSecurityAutomationScopeObject

## SYNOPSIS
{{ Fill in the Synopsis }}
Creates security automation scope object

## SYNTAX

Expand All @@ -18,16 +18,16 @@ New-AzSecurityAutomationScopeObject -Description <String> -ScopePath <String>
```

## DESCRIPTION
{{ Fill in the Description }}
Creates security automation scope object

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> New-AzSecurityAutomationScopeObject -Description 'Security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5' -ScopePath '/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup'
```

{{ Add example description here }}
Creates security automation scope object

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzSecurityAutomationSourceObject

## SYNOPSIS
{{ Fill in the Synopsis }}
Creates security automation source object

## SYNTAX

Expand All @@ -24,16 +24,16 @@ New-AzSecurityAutomationSourceObject -EventSource <String> -RuleSets <PSSecurity
```

## DESCRIPTION
{{ Fill in the Description }}
Creates security automation source object

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> New-AzSecurityAutomationSourceObject -EventSource 'Assessments' -RuleSet $ruleSet
```

{{ Add example description here }}
Creates security automation source object

## PARAMETERS

Expand Down
8 changes: 4 additions & 4 deletions src/Security/Security/help/Remove-AzSecurityAutomation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Remove-AzSecurityAutomation

## SYNOPSIS
{{ Fill in the Synopsis }}
Deletes security automation

## SYNTAX

Expand All @@ -31,16 +31,16 @@ Remove-AzSecurityAutomation -InputObject <PSSecurityAutomation> [-PassThru]
```

## DESCRIPTION
{{ Fill in the Description }}
Deletes security automation

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
PS C:\> Remove-AzSecurityAutomation -ResourceGroupName 'sampleResourceGroup' -Name 'sampleAutomation'
```

{{ Add example description here }}
Deletes security automation named 'sampleAutomation' under resource group named 'sampleResourceGroup'

## PARAMETERS

Expand Down