Skip to content

[NetworkCloud] Add breaking change announcement for autorest v4 #28273

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JoyerJin
Copy link
Contributor

@JoyerJin JoyerJin commented Jul 25, 2025

Description

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

Copy link

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

@JoyerJin JoyerJin marked this pull request as ready for review August 1, 2025 06:13
@Copilot Copilot AI review requested due to automatic review settings August 1, 2025 06:13
@JoyerJin JoyerJin added the Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change label Aug 1, 2025
Copy link
Contributor

@Copilot 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

This PR implements breaking change announcements for the NetworkCloud module in preparation for AutoRest v4 migration. The changes primarily focus on updating type definitions from fixed arrays to generic Lists and improving security by redacting sensitive information in documentation examples.

  • Updates parameter type annotations to include breaking change warnings for array-to-List conversions
  • Redacts password values in documentation examples with "REDACTED" placeholder
  • Updates module dependencies and configuration files for AutoRest v4 compatibility

Reviewed Changes

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

Show a summary per file
File Description
help/*.md Redacts password values in PowerShell examples for security
Az.NetworkCloud.psd1 Updates Az.Accounts dependency version and generation date
NetworkCloud.sln Restructures solution file with new project references and build configurations
custom/*.ps1 Adds breaking change annotations for parameters transitioning from Array to List types
README.md Adds extensive breaking change configurations for AutoRest v4 migration
Various documentation files Updates path separators from Unix to Windows style and fixes typos
Comments suppressed due to low confidence (5)

src/NetworkCloud/NetworkCloud.Autorest/examples/New-AzNetworkCloudServiceLoadBalancerBgpPeerObject.md:3

  • The password parameter value contains a typo: 'passsword' should be 'password'. However, since this is being replaced with 'REDACTED' for security reasons, this is already being fixed.
New-AzNetworkCloudServiceLoadBalancerBgpPeerObject -Name name -PeerAddress "203.0.113.254" -PeerAsn "64497" -BfdEnabled False -BgpMultiHop False -HoldTime "P300s" -KeepAliveTime "P300s" -MyAsn 64512 -Password REDACTED -PeerPort 1234

src/NetworkCloud/NetworkCloud.Autorest/docs/New-AzNetworkCloudServiceLoadBalancerBgpPeerObject.md:28

  • The password parameter value contains a typo: 'passsword' should be 'password'. However, since this is being replaced with 'REDACTED' for security reasons, this is already being fixed.
New-AzNetworkCloudServiceLoadBalancerBgpPeerObject -Name name -PeerAddress "203.0.113.254" -PeerAsn "64497" -BfdEnabled False -BgpMultiHop False -HoldTime "P300s" -KeepAliveTime "P300s" -MyAsn 64512 -Password REDACTED -PeerPort 1234

src/NetworkCloud/NetworkCloud.Autorest/examples/New-AzNetworkCloudBgpServiceLoadBalancerConfigurationObject.md:6

  • The password parameter value contains a typo: 'passsword' should be 'password'. However, since this is being replaced with 'REDACTED' for security reasons, this is already being fixed.
$serviceLoadBalancerBgpPeer=New-AzNetworkCloudServiceLoadBalancerBgpPeerObject -Name name -PeerAddress "203.0.113.254" -PeerAsn "64497" -BfdEnabled False -BgpMultiHop False -HoldTime "P300s" -KeepAliveTime "P300s" -MyAsn 64512 -Password REDACTED -PeerPort 1234

src/NetworkCloud/NetworkCloud.Autorest/docs/New-AzNetworkCloudBgpServiceLoadBalancerConfigurationObject.md:31

  • The password parameter value contains a typo: 'passsword' should be 'password'. However, since this is being replaced with 'REDACTED' for security reasons, this is already being fixed.
$serviceLoadBalancerBgpPeer=New-AzNetworkCloudServiceLoadBalancerBgpPeerObject -Name name -PeerAddress "203.0.113.254" -PeerAsn "64497" -BfdEnabled False -BgpMultiHop False -HoldTime "P300s" -KeepAliveTime "P300s" -MyAsn 64512 -Password REDACTED -PeerPort 1234

src/NetworkCloud/NetworkCloud.Autorest/examples/Invoke-AzNetworkCloudBareMetalMachineDataExtract.md:8

  • The ResourceGroupName parameter value contains a typo: 'resourcceGroupName' should be 'resourceGroupName'. This is being corrected in the updated line.
Invoke-AzNetworkCloudBareMetalMachineDataExtract -BareMetalMachineName bmmName -ResourceGroupName resourceGroupName -SubscriptionId subscriptionId -Command $command -LimitTimeSecond limitTimeInSeconds -Debug

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant