[Automated Tracing] Enable support for vnet peering and multiple interfaces

[arudell]

Description

This pull request updates the Enable-SdnNetworkInterfaceTrace function to support enabling network tracing for multiple network interfaces at once, and improves the logic for mapping virtual gateways, including peered virtual networks. It also enhances the documentation and parameter validation to reflect these new capabilities.

Enhancements to multi-interface support:

• Updated the NetworkInterface parameter to accept an array of objects, allowing tracing to be enabled for one or more interfaces simultaneously. The parameter validation logic now checks each provided object for the correct resource type. (F7a09d14L2358R2376)
• Refactored the function logic to iterate over each provided network interface, ensuring all relevant operations (e.g., subnet association, VFP port lookup, public IP resolution) are performed per interface. [1] [2]

Improvements to virtual gateway mapping:

• Enhanced the logic for identifying associated virtual gateways, including resolving gateways from peered virtual networks when useRemoteGateways is set. The function now builds a list of all relevant gateways, rather than stopping at the first match.

Documentation and usability:

• Updated the function's help documentation to clarify support for multiple interfaces and added several usage examples demonstrating both array and pipeline input. (F7a09d14L2358R2376)

No significant changes were made to Test-SdnProviderNetwork in this pull request.

Change type

• Bug fix (non-breaking change)
• Code style update (formatting, local variables)
• New Feature (non-breaking change that adds new functionality without impacting existing)
• Breaking change (fix or feature that may cause functionality impact)
• Other

Checklist:

• My code follows the style and contribution guidelines of this project.
• I have tested and validated my code changes.