Skip to content

[SecurityInsights] Refresh documents#29272

Merged
VeryEarly merged 1 commit intomainfrom
nori/fix-securityInsights-doc
Mar 16, 2026
Merged

[SecurityInsights] Refresh documents#29272
VeryEarly merged 1 commit intomainfrom
nori/fix-securityInsights-doc

Conversation

@NoriZC
Copy link
Contributor

@NoriZC NoriZC commented Mar 16, 2026

Description

#29247 by @Faizan-Alam-1

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copilot AI review requested due to automatic review settings March 16, 2026 00:45
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refreshes the Az.SecurityInsights module’s generated/help documentation and associated metadata, aligning examples and generated artifacts with the latest autorest output for the SecurityInsights module.

Changes:

  • Updated several cmdlet help examples (e.g., incident update, entity examples, alert rule creation).
  • Refreshed generated module metadata/artifacts (module manifest, solution/project IDs, generate-info, assembly versions).
  • Updated some sample GUIDs/identifiers in documentation outputs.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
src/SecurityInsights/SecurityInsights/help/Update-AzSentinelIncident.md Updates example command for incident update help content.
src/SecurityInsights/SecurityInsights/help/New-AzSentinelIncidentTeam.md Updates Teams URL sample output (tenantId).
src/SecurityInsights/SecurityInsights/help/New-AzSentinelAlertRule.md Updates Scheduled alert rule example content.
src/SecurityInsights/SecurityInsights/help/Get-AzSentinelEntityInsight.md Updates sample EntityId used in example.
src/SecurityInsights/SecurityInsights/help/Get-AzSentinelEntityActivity.md Adjusts example description text.
src/SecurityInsights/SecurityInsights/help/Get-AzSentinelEntity.md Adjusts Example 3 variable usage in pipeline example.
src/SecurityInsights/SecurityInsights/Az.SecurityInsights.psd1 Refreshes manifest generation date, Az.Accounts dependency, and formatting; bumps module version.
src/SecurityInsights/SecurityInsights.sln Updates solution project GUID references for Az.SecurityInsights project.
src/SecurityInsights/SecurityInsights.Autorest/generate-info.json Updates generation ID.
src/SecurityInsights/SecurityInsights.Autorest/examples/Update-AzSentinelIncident.md Updates incident update example snippet.
src/SecurityInsights/SecurityInsights.Autorest/docs/Update-AzSentinelIncident.md Updates incident update docs example.
src/SecurityInsights/SecurityInsights.Autorest/docs/Az.SecurityInsights.md Updates module doc page GUID.
src/SecurityInsights/SecurityInsights.Autorest/Properties/AssemblyInfo.cs Bumps assembly version from 3.2.0 to 3.2.1.
Comments suppressed due to low confidence (1)

src/SecurityInsights/SecurityInsights.Autorest/docs/Update-AzSentinelIncident.md:49

  • The example now updates multiple fields (Title/Status/Severity) in addition to assigning an owner, but the description sentence below the example still says it only assigns an owner. Please update the description to match the example's behavior.
Update-AzSentinelIncident -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Id "4a21e485-75ae-48b3-a7b9-e6a92bcfe434" -Title "Suspicious login activity" -Status "Active" -Severity "Medium" -OwnerAssignedTo "user@mydomain.local"

This command updates an incident by assigning an owner.

</details>

Update-AzSentinelIncident -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Id "4a21e485-75ae-48b3-a7b9-e6a92bcfe434" -Title "Suspicious login activity" -Status "Active" -Severity "Medium" -OwnerAssignedTo "user@mydomain.local"
```

This command updates an incident by assigning an owner.
Update-AzSentinelIncident -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Id "4a21e485-75ae-48b3-a7b9-e6a92bcfe434" -Title "Suspicious login activity" -Status "Active" -Severity "Medium" -OwnerAssignedTo "user@mydomain.local"
```

This command updates an incident by assigning an owner.
Comment on lines 98 to 100
```powershell
New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Execution Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventID == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 -TriggerOperator "GreaterThan"
New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Exection Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventId == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10
```
### Example 5: Create a Scheduled Alert Rule
```powershell
New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Execution Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventID == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 -TriggerOperator "GreaterThan"
New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Exection Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventId == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10
```

This command gets insights and activities for an Entity by object
This command gets insights and activies for an Entity by object
Comment on lines +70 to +71
$Entitys = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"
$Entitys[0] | Get-AzSentinelEntity
@VeryEarly VeryEarly merged commit 34432c3 into main Mar 16, 2026
16 checks passed
@VeryEarly VeryEarly deleted the nori/fix-securityInsights-doc branch March 16, 2026 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants