Fixed default parameter set for migration #29049

Ptnan7 · 2026-01-11T23:30:01Z

Description

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/{{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

azure-client-tools-bot-prd · 2026-01-11T23:30:08Z

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

isra-fel · 2026-01-11T23:38:15Z

/azp run

azure-pipelines · 2026-01-11T23:38:31Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

This pull request fixes a parameter set issue in the Start-AzFrontDoorCdnProfilePrepareMigration cmdlet. The cmdlet now correctly defaults to the 'CreateExpanded' parameter set when the MigrationWebApplicationFirewallMapping parameter is not provided, and properly handles null/empty WAF mapping parameters.

Changes:

Added DefaultParameterSetName='CreateExpanded' to the cmdlet binding to ensure proper parameter set selection
Enhanced null/empty parameter handling for MigrationWebApplicationFirewallMapping with safer validation logic
Updated help documentation to reflect the corrected default parameter set

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Cdn/Cdn.Autorest/custom/Start-AzFrontDoorCdnProfilePrepareMigration.ps1	Added DefaultParameterSetName and improved null handling for WAF mapping parameter
src/Cdn/Cdn/help/Start-AzFrontDoorCdnProfilePrepareMigration.md	Updated help documentation to show CreateExpanded as the default parameter set
src/Cdn/Cdn.Autorest/docs/Start-AzFrontDoorCdnProfilePrepareMigration.md	Updated AutoRest docs to show CreateExpanded as the default parameter set
src/Cdn/Cdn/ChangeLog.md	Added changelog entry for the fix
src/Cdn/Cdn/Az.Cdn.psd1	Updated generated date and formatting (auto-generated changes)
src/Cdn/Cdn.sln	Updated project GUID (auto-generated change)
src/Cdn/Cdn.Autorest/generate-info.json	Updated generate ID (auto-generated change)
src/Cdn/Cdn.Autorest/docs/Az.Cdn.md	Updated module GUID (auto-generated change)
src/Cdn/Cdn.Autorest/Properties/AssemblyInfo.cs	Updated assembly version from 5.0.1 to 6.0.0

Copilot · 2026-01-11T23:45:07Z

src/Cdn/Cdn/ChangeLog.md

 -->

 ## Upcoming Release
+* Fixed default parameter set issue.


The ChangeLog entry "Fixed default parameter set issue" is too vague and not user-focused. According to the coding guidelines for ChangeLog.md files, entries should be written from the user's perspective and explain what changed and how it affects their usage. Consider rephrasing to something like: "Fixed parameter set selection for 'Start-AzFrontDoorCdnProfilePrepareMigration' cmdlet to properly default to 'CreateExpanded' when 'MigrationWebApplicationFirewallMapping' is not provided."

Copilot · 2026-01-11T23:45:07Z

src/Cdn/Cdn.Autorest/custom/Start-AzFrontDoorCdnProfilePrepareMigration.ps1

+    if (-not ${MigrationWebApplicationFirewallMapping} -or ${MigrationWebApplicationFirewallMapping}.count -eq 0) {
+        Write-Debug("No WAF policies to validate.")
+        return
+    }
+
    if (${MigrationWebApplicationFirewallMapping}.count -gt 0) {


The ValidateWafPolicies function has redundant logic. Lines 436-439 check if MigrationWebApplicationFirewallMapping is null or empty and return early, but then line 441 checks the same condition again. The inner if statement on line 441 will always be true when reached since we've already returned early if count is 0. Consider removing the redundant check on line 441.

isra-fel · 2026-01-12T00:38:27Z

/azp run

azure-pipelines · 2026-01-12T00:38:42Z

Azure Pipelines successfully started running 3 pipeline(s).

vidai-msft · 2026-01-12T06:59:26Z

@Ptnan7 The default parameter set has been updated which causes breaking change. Can you please confirm it is really a breaking change? If so, this PR can only be merged during bc window.

Ptnan7 · 2026-01-12T23:23:48Z

@vidai-msft
There is a bug in parameter set so we commit a PR to adjust a mandatory parameter, is this a breaking change? Our customer wants to use this command before April, if it is, I think he need to use azure cli instead.

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Copilot · 2026-01-12T23:31:54Z

src/Cdn/Cdn.Autorest/custom/Start-AzFrontDoorCdnProfilePrepareMigration.ps1

+        } else {
+            # In CreateExpanded, if Front Door has WAF policies, user must use MigrateExpanded parameter set
+            if ($allPoliciesWithWAF.count -gt 0) {
+                throw "The Front Door has $($allPoliciesWithWAF.count) WAF policy/policies associated. Please provide the -MigrationWebApplicationFirewallMapping parameter with WAF policy mappings."


The error message uses "policy/policies" which appears awkward. Consider rephrasing to be more grammatically clear, such as: "The Front Door has $($allPoliciesWithWAF.count) associated WAF $(if ($allPoliciesWithWAF.count -eq 1) { 'policy' } else { 'policies' }). Please provide the -MigrationWebApplicationFirewallMapping parameter with WAF policy mappings."

Suggested change

throw "The Front Door has $($allPoliciesWithWAF.count) WAF policy/policies associated. Please provide the -MigrationWebApplicationFirewallMapping parameter with WAF policy mappings."

throw "The Front Door has $($allPoliciesWithWAF.count) associated WAF $(if ($allPoliciesWithWAF.count -eq 1) { 'policy' } else { 'policies' }). Please provide the -MigrationWebApplicationFirewallMapping parameter with WAF policy mappings."

Copilot · 2026-01-12T23:31:54Z

src/Cdn/Cdn.Autorest/custom/Start-AzFrontDoorCdnProfilePrepareMigration.ps1

+            # In MigrateExpanded, MigrationWebApplicationFirewallMapping is mandatory
+            # Validate the count matches
+            if (${MigrationWebApplicationFirewallMapping}.count -ne $allPoliciesWithWAF.count) {
+                throw "MigrationWebApplicationFirewallMapping parameter instance should be equal to the number of WAF policy instance in the profile. Expected: $($allPoliciesWithWAF.count), Provided: $($MigrationWebApplicationFirewallMapping.count)"


The error message enhancement provides better clarity by showing both expected and provided counts. However, consider using consistent terminology. The message says "parameter instance" which might be unclear to users. Consider rewording to: "The number of WAF mapping entries must match the number of WAF policies in the profile. Expected: $($allPoliciesWithWAF.count), Provided: $($MigrationWebApplicationFirewallMapping.count)"

Suggested change

throw "MigrationWebApplicationFirewallMapping parameter instance should be equal to the number of WAF policy instance in the profile. Expected: $($allPoliciesWithWAF.count), Provided: $($MigrationWebApplicationFirewallMapping.count)"

throw "The number of WAF mapping entries must match the number of WAF policies in the profile. Expected: $($allPoliciesWithWAF.count), Provided: $($MigrationWebApplicationFirewallMapping.count)"

isra-fel · 2026-01-12T23:38:44Z

/azp run

azure-pipelines · 2026-01-12T23:39:01Z

Azure Pipelines successfully started running 3 pipeline(s).

vidai-msft · 2026-01-13T02:34:55Z

@Ptnan7 You changed the default parameter set and also the param -MigrationWebApplicationFirewallMapping was updated from optional to required. These are considered as breaking changes for sure. This PR is only allowed to be merged during Build or Ignite release.

github-actions · 2026-01-13T02:35:30Z

To the author of the pull request,
This PR was labeled "Contains Breaking Change" because breaking changes have been detected by the static analysis pipeline.

According to our policy, breaking changes can only take place during major release and they must be preannounced.
Please follow our guide on the detailed steps.
Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

done

1772bc8

Copilot AI review requested due to automatic review settings January 11, 2026 23:30

Copilot started reviewing on behalf of Ptnan7 January 11, 2026 23:32 View session

Copilot AI reviewed Jan 11, 2026

View reviewed changes

fix

6f2f7ec

fix

57e59c6

Copilot AI review requested due to automatic review settings January 12, 2026 23:21

Copilot started reviewing on behalf of Ptnan7 January 12, 2026 23:24 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

vidai-msft added the Contains Breaking Change This PR contains breaking change label Jan 13, 2026

	throw "The Front Door has $($allPoliciesWithWAF.count) WAF policy/policies associated. Please provide the -MigrationWebApplicationFirewallMapping parameter with WAF policy mappings."
	throw "The Front Door has $($allPoliciesWithWAF.count) associated WAF $(if ($allPoliciesWithWAF.count -eq 1) { 'policy' } else { 'policies' }). Please provide the -MigrationWebApplicationFirewallMapping parameter with WAF policy mappings."

	throw "MigrationWebApplicationFirewallMapping parameter instance should be equal to the number of WAF policy instance in the profile. Expected: $($allPoliciesWithWAF.count), Provided: $($MigrationWebApplicationFirewallMapping.count)"
	throw "The number of WAF mapping entries must match the number of WAF policies in the profile. Expected: $($allPoliciesWithWAF.count), Provided: $($MigrationWebApplicationFirewallMapping.count)"

Fixed default parameter set for migration #29049

Are you sure you want to change the base?

Fixed default parameter set for migration #29049

Uh oh!

Conversation

Ptnan7 commented Jan 11, 2026

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Jan 11, 2026

Uh oh!

isra-fel commented Jan 11, 2026

Uh oh!

azure-pipelines bot commented Jan 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

isra-fel commented Jan 12, 2026

Uh oh!

azure-pipelines bot commented Jan 12, 2026

Uh oh!

vidai-msft commented Jan 12, 2026

Uh oh!

Ptnan7 commented Jan 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

isra-fel commented Jan 12, 2026

Uh oh!

azure-pipelines bot commented Jan 12, 2026

Uh oh!

vidai-msft commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants