[Az.Network] Updated New-AzNetworkWatcherPacketCaptureV2 command and added a new sub command 'New-AzPacketCaptureSettingsConfig' for Network watcher Packet capture include ring buffer change. #27880

v-sapanchal · 2025-06-02T10:59:48Z

Description

Modified the existing Packet capture command include ring buffer change, in order to that, created a new sub command for capture settings,
Example:

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/Network/Network/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

… mapping

azure-client-tools-bot-prd · 2025-06-02T10:59:55Z

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

Copilot

Pull Request Overview

This pull request updates the Packet Capture commands by introducing a new subcommand (New-AzPacketCaptureSettingsConfig) to encapsulate capture settings and by modifying New-AzNetworkWatcherPacketCaptureV2 to support ring buffer configurations via new parameters. Key changes include:

Adding a new cmdlet to generate capture settings objects.
Updating Packet Capture V2 to accept ContinuousCapture, CaptureSettings, and LocalPath parameters.
Adjusting help files, tests, and command mappings to incorporate the new functionality.

Reviewed Changes

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

Show a summary per file

File	Description
tools/StaticAnalysis/Exceptions/Az.Network/SignatureIssues.csv	Updated signature exceptions for New-AzNetworkWatcherPacketCaptureV2 to flag naming convention issues.
tools/StaticAnalysis/Exceptions/Az.Network/ExampleIssues.csv	Added new example entries for New-AzPacketCaptureSettingsConfig.
src/Network/Network/help/New-AzPacketCaptureSettingsConfig.md	New help file documenting the new subcommand.
src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md	Updated help file reflecting new parameters and example with ring buffer capture.
src/Network/Network/NetworkWatcher/PacketCapture/NewPacketCaptureSettingsCommand.cs	New implementation for creating packet capture settings objects.
src/Network/Network/NetworkWatcher/PacketCapture/NewAzureNetworkWatcherPacketCaptureCommandV2.cs	Modified to add support for ContinuousCapture, CaptureSettings, and LocalPath parameters.
src/Network/Network/Models/PSPacketCaptureSettings.cs	New model supporting file count, file size, and session time limit settings.
src/Network/Network/ChangeLog.md	Updated to mention new commands and parameter additions.
src/Network/Network/Az.Network.psd1	Updated command exports to include the new subcommand.
src/Network/Network.Test/ScenarioTests/NetworkWatcherAPITests.ps1 & cs	Added tests validating the new capture settings functionality.
src/Accounts/Accounts/Utilities/CommandMappings.json	Included the new command mapping for New-AzPacketCaptureSettingsConfig.

Comments suppressed due to low confidence (2)

tools/StaticAnalysis/Exceptions/Az.Network/SignatureIssues.csv:462

The exception message flags the 'CaptureSettings' parameter naming for New-AzNetworkWatcherPacketCaptureV2. Consider revising the parameter name to use a singular noun for consistency, or update the enforced naming convention if appropriate.

+"Az.Network","Microsoft.Azure.Commands.Network.NewAzureNetworkWatcherPacketCaptureCommandV2","New-AzNetworkWatcherPacketCaptureV2","1","8410","Parameter CaptureSettings of cmdlet New-AzNetworkWatcherPacketCaptureV2 does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name."

src/Network/Network/NetworkWatcher/PacketCapture/NewAzureNetworkWatcherPacketCaptureCommandV2.cs:308

There is an inconsistency in parameter naming between 'LocalFilePath' and 'LocalPath'. Consolidate these names to a single consistent identifier to avoid confusion and improve clarity in both the cmdlet implementation and its documentation.

packetCaptureProperties.StorageLocation.FilePath = this.LocalFilePath;

src/Network/Network.Test/ScenarioTests/NetworkWatcherAPITests.ps1

kumaam · 2025-06-12T20:14:57Z

...Network/Network/NetworkWatcher/PacketCapture/NewAzureNetworkWatcherPacketCaptureCommandV2.cs

+
+        [Parameter(
+             Mandatory = false,
+             HelpMessage = "Filters for packet capture session.")]


update the description from swagger repo. Also mentions, only required when continous capture field is being set.

kumaam · 2025-06-12T20:18:32Z

...Network/Network/NetworkWatcher/PacketCapture/NewAzureNetworkWatcherPacketCaptureCommandV2.cs

+                        FileCount = 10,
+                        FileSizeInBytes = 104857600,
+                        SessionTimeLimitInSeconds = 86400
+                    };


do we need to pass these default values ?
What if we don't pass captureSettings as well, this should be set at the server side, right ?

kumaam · 2025-06-12T20:20:18Z

...Network/Network/NetworkWatcher/PacketCapture/NewAzureNetworkWatcherPacketCaptureCommandV2.cs

+                }
+                else
+                {
+                    this.CaptureSettings.FileCount = this.CaptureSettings.FileCount ?? 10;


I don't think we need to set default value here, it should be taken care by server only, lets test this behavior once.
applicable to other fields as well.

kumaam · 2025-06-12T20:20:47Z

...Network/Network/NetworkWatcher/PacketCapture/NewAzureNetworkWatcherPacketCaptureCommandV2.cs

+                    this.CaptureSettings.FileSizeInBytes = this.CaptureSettings.FileSizeInBytes ?? 104857600;
+                    this.CaptureSettings.SessionTimeLimitInSeconds = this.CaptureSettings.SessionTimeLimitInSeconds ?? 86400;
+
+                    if (this.CaptureSettings.FileCount < 1 || this.CaptureSettings.FileCount > 10000)


nit - lets do the validation before assignment,

kumaam · 2025-06-12T20:26:20Z

src/Network/Network/NetworkWatcher/PacketCapture/NewPacketCaptureSettingsCommand.cs

+            base.Execute();
+
+            // Set default values if null
+            if (this.FileCount == null)


lets check if we need to set default value here or not ?

kumaam · 2025-06-12T20:27:35Z

src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md

- [-Scope <PSPacketCaptureMachineScope>] [-TargetType <String>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob]
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+ [-StorageAccountId <String>] [-StoragePath <String>] [-FilePath <String>] [-BytesToCapturePerPacket <Int32>]


FilePath -> LocalFilePath.

kumaam · 2025-06-12T20:27:49Z

src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md

 ```

 ### SetByName
 ```
 New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String>
- -TargetId <String> [-StorageAccountId <String>] [-StoragePath <String>] [-LocalFilePath <String>]
+ -TargetId <String> [-StorageAccountId <String>] [-StoragePath <String>] [-FilePath <String>]


LocalFilePath

line number 38 as well

kumaam · 2025-06-12T20:30:14Z

src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md

@@ -242,6 +277,36 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```

+### -CaptureSettings
+Filters for packet capture session.


update the description. This is not filter, this is capture settings.
Update -> Capture Settings for packet capture session. Should only be provided when continous capture field is set.

kumaam · 2025-06-12T20:31:11Z

src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md

-### -LocalFilePath
-Local file path.
+### -LocalPath
+This path is valid if 'ContinuousCapture' is provided and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap).


can;t both storageId or local path be provided ?

v-sapanchal added 2 commits June 2, 2025 12:46

Added a new command and related update for continuous capture and its…

6985eb0

… mapping

Added help doc, mapped in network command,Test case and session records

5b063be

v-sapanchal added this to the Az 14.2.0 (07/01/2025) milestone Jun 2, 2025

v-sapanchal and others added 4 commits June 5, 2025 12:53

Merge branch 'main' into spanchal/pcap_ring_buffer_new

b7522c4

Modified the change log as per the new offerings

0ec50e2

StaticAnalysis issue

252f3cd

reverted to the old file format and added our records for supress

2d2eccc

v-sapanchal marked this pull request as ready for review June 13, 2025 10:47

Copilot AI review requested due to automatic review settings June 13, 2025 10:47

Copilot AI reviewed Jun 13, 2025

View reviewed changes

kumaam reviewed Jun 13, 2025

View reviewed changes

Added some Test assert regarding capture settings

2df74d7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Az.Network] Updated New-AzNetworkWatcherPacketCaptureV2 command and added a new sub command 'New-AzPacketCaptureSettingsConfig' for Network watcher Packet capture include ring buffer change. #27880

[Az.Network] Updated New-AzNetworkWatcherPacketCaptureV2 command and added a new sub command 'New-AzPacketCaptureSettingsConfig' for Network watcher Packet capture include ring buffer change. #27880

Uh oh!

v-sapanchal commented Jun 2, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Jun 2, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

kumaam Jun 12, 2025

Uh oh!

Uh oh!

[Az.Network] Updated New-AzNetworkWatcherPacketCaptureV2 command and added a new sub command 'New-AzPacketCaptureSettingsConfig' for Network watcher Packet capture include ring buffer change. #27880

Are you sure you want to change the base?

[Az.Network] Updated New-AzNetworkWatcherPacketCaptureV2 command and added a new sub command 'New-AzPacketCaptureSettingsConfig' for Network watcher Packet capture include ring buffer change. #27880

Uh oh!

Conversation

v-sapanchal commented Jun 2, 2025

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Jun 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

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!

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!

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!