Skip to content

Commit d37d457

Browse files
surashedsurashed
authored
Update helpers with explanations & examples (#17841)
* add models * minor changes on the Automation Models * add models converters * changes * changes * changes * changes * changes * fix * Get-AzSecurityAutomation fixes * changes * changes * changes * changes * update help files * changes * Add testing for Automations cmdlets * align SecurityAutomationTests.ps1 * minor fix * Add Automations tests recording * Add changes description to ChangeLog.md * changes * Add help commands * Add help commands * Add help commands * minor alignments on security test * minor fixes * update tests * a * update * update * changee * update tests * update tests * update tests * renaming * Align AzSecurityAutomation helper function names * fix test * updates * Update SignatureIssues.csv * update heloers with explanations & examples * minor fixes
1 parent 8a6b8b7 commit d37d457

10 files changed

+69
-40
lines changed

‎src/Security/Security/help/Az.Security.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Enforces the given rules on the NSG(s) listed in the request
1818
Add SQL vulnerability assessment baseline.
1919

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

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

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

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

161161
### [New-AzSecurityAutomation](New-AzSecurityAutomation.md)
162-
{{ Fill in the Synopsis }}
162+
Creates new security automation
163+
164+
### [New-AzSecurityAutomationActionObject](New-AzSecurityAutomationActionObject.md)
165+
Creates new security automation action object
166+
167+
### [New-AzSecurityAutomationRuleObject](New-AzSecurityAutomationRuleObject.md)
168+
Creates new security automation rule object
169+
170+
### [New-AzSecurityAutomationRuleSetObject](New-AzSecurityAutomationRuleSetObject.md)
171+
Creates new security automation rule set object
172+
173+
### [New-AzSecurityAutomationScopeObject](New-AzSecurityAutomationScopeObject.md)
174+
Creates new security automation scope object
175+
176+
### [New-AzSecurityAutomationSourceObject](New-AzSecurityAutomationSourceObject.md)
177+
Creates new security automation source object
163178

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

179194
### [Remove-AzSecurityAutomation](Remove-AzSecurityAutomation.md)
180-
{{ Fill in the Synopsis }}
195+
Deletes security automation
181196

182197
### [Remove-AzSecurityContact](Remove-AzSecurityContact.md)
183198
Deletes a security contact.

‎src/Security/Security/help/Confirm-AzSecurityAutomation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Confirm-AzSecurityAutomation
99

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

1313
## SYNTAX
1414

@@ -37,16 +37,16 @@ Confirm-AzSecurityAutomation [-Location <String>] [-Etag <String>] [-Tag <Hashta
3737
```
3838

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

4242
## EXAMPLES
4343

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

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

5151
## PARAMETERS
5252

‎src/Security/Security/help/Get-AzSecurityAutomation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzSecurityAutomation
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Gets security automations
1212

1313
## SYNTAX
1414

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

3737
## DESCRIPTION
38-
{{ Fill in the Description }}
38+
Gets security automations
3939

4040
## EXAMPLES
4141

4242
### Example 1
4343
```powershell
44-
PS C:\> {{ Add example code here }}
44+
PS C:\> Get-AzSecurityAutomation
4545
```
4646

47-
{{ Add example description here }}
47+
Gets all security automations under the subscription
4848

4949
## PARAMETERS
5050

‎src/Security/Security/help/New-AzSecurityAutomation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzSecurityAutomation
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates new security automation
1212

1313
## SYNTAX
1414

@@ -37,16 +37,16 @@ New-AzSecurityAutomation [-Location <String>] [-Etag <String>] [-Tag <Hashtable>
3737
```
3838

3939
## DESCRIPTION
40-
{{ Fill in the Description }}
40+
Creates new security automation
4141

4242
## EXAMPLES
4343

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

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

5151
## PARAMETERS
5252

‎src/Security/Security/help/New-AzSecurityAutomationActionObject.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzSecurityAutomationActionObject
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates new security automation action object
1212

1313
## SYNTAX
1414

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

3333
## DESCRIPTION
34-
{{ Fill in the Description }}
34+
Creates new security automation action object
3535

3636
## EXAMPLES
3737

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

43-
{{ Add example description here }}
43+
Creates new security automation action with workspace type
44+
45+
### Example 2
46+
```powershell
47+
PS C:\> New-AzSecurityAutomationActionObject -LogicAppResourceId '/subscriptions/03b601f1-7eca-4496-8f8d-355219eee254/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/workflows/LA' -Uri 'https://dummy.com/'
48+
```
49+
50+
Creates new security automation action with logicApp type
51+
52+
### Example 3
53+
```powershell
54+
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'
55+
```
56+
57+
Creates new security automation action with even-hub type
4458

4559
## PARAMETERS
4660

‎src/Security/Security/help/New-AzSecurityAutomationRuleObject.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzSecurityAutomationRuleObject
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates security automation rule object
1212

1313
## SYNTAX
1414

@@ -18,16 +18,16 @@ New-AzSecurityAutomationRuleObject -PropertyJPath <String> -Operator <String> -E
1818
```
1919

2020
## DESCRIPTION
21-
{{ Fill in the Description }}
21+
Creates security automation rule object
2222

2323
## EXAMPLES
2424

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

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

3232
## PARAMETERS
3333

‎src/Security/Security/help/New-AzSecurityAutomationRuleSetObject.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzSecurityAutomationRuleSetObject
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates security automation rule set object
1212

1313
## SYNTAX
1414

@@ -18,16 +18,16 @@ New-AzSecurityAutomationRuleSetObject -Rules <PSSecurityAutomationTriggeringRule
1818
```
1919

2020
## DESCRIPTION
21-
{{ Fill in the Description }}
21+
Creates security automation rule set object
2222

2323
## EXAMPLES
2424

2525
### Example 1
2626
```powershell
27-
PS C:\> {{ Add example code here }}
27+
PS C:\> New-AzSecurityAutomationRuleSetObject -Rule $rule
2828
```
2929

30-
{{ Add example description here }}
30+
Creates security automation rule set object
3131

3232
## PARAMETERS
3333

‎src/Security/Security/help/New-AzSecurityAutomationScopeObject.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzSecurityAutomationScopeObject
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates security automation scope object
1212

1313
## SYNTAX
1414

@@ -18,16 +18,16 @@ New-AzSecurityAutomationScopeObject -Description <String> -ScopePath <String>
1818
```
1919

2020
## DESCRIPTION
21-
{{ Fill in the Description }}
21+
Creates security automation scope object
2222

2323
## EXAMPLES
2424

2525
### Example 1
2626
```powershell
27-
PS C:\> {{ Add example code here }}
27+
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'
2828
```
2929

30-
{{ Add example description here }}
30+
Creates security automation scope object
3131

3232
## PARAMETERS
3333

‎src/Security/Security/help/New-AzSecurityAutomationSourceObject.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzSecurityAutomationSourceObject
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Creates security automation source object
1212

1313
## SYNTAX
1414

@@ -24,16 +24,16 @@ New-AzSecurityAutomationSourceObject -EventSource <String> -RuleSets <PSSecurity
2424
```
2525

2626
## DESCRIPTION
27-
{{ Fill in the Description }}
27+
Creates security automation source object
2828

2929
## EXAMPLES
3030

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

36-
{{ Add example description here }}
36+
Creates security automation source object
3737

3838
## PARAMETERS
3939

‎src/Security/Security/help/Remove-AzSecurityAutomation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Remove-AzSecurityAutomation
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Deletes security automation
1212

1313
## SYNTAX
1414

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

3333
## DESCRIPTION
34-
{{ Fill in the Description }}
34+
Deletes security automation
3535

3636
## EXAMPLES
3737

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

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

4545
## PARAMETERS
4646

0 commit comments

Comments
 (0)