upgrade websites module to autorest v4 by Pan-Qi · Pull Request #28268 · Azure/azure-powershell

Pan-Qi · 2025-07-24T13:57:35Z

Description

Preannouncement PR:

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 · 2025-07-24T13:57:42Z

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

Copilot

Pull Request Overview

This PR upgrades the Azure PowerShell Websites module to use AutoRest v4, introducing various new features and breaking changes.

Upgrades the code generator from AutoRest v3 to v4, bringing new parameter sets and parameter types
Updates cmdlet signatures, particularly for Static Web App cmdlets with new identity management parameters
Changes many API response models from versioned namespaces to unversioned interfaces

Reviewed Changes

Copilot reviewed 112 out of 112 changed files in this pull request and generated 1 comment.

File	Description
tools/StaticAnalysis/Exceptions/Az.LoadTesting/BreakingChangeIssues.csv	Documents breaking changes including type changes, removed parameters, and removed parameter sets
src/Websites/Websites/help/*.md	Updates documentation for cmdlets with new parameter sets, type changes, and corrected descriptions
src/Websites/Websites/ChangeLog.md	Documents the upgrade and breaking changes for New-AzStaticWebApp identity parameters
src/Websites/Websites/Az.Websites.psd1	Updates module metadata including required Az.Accounts version and file paths

Copilot · 2025-08-06T13:52:20Z

src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md

 ### Example 2: Create or updates the app settings of a static site build by pipeline
 ```powershell
-Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }
+Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }


There's a typo in the example: 'taticweb00' should be 'staticweb00' to match the expected static web app naming convention.

Suggested change

Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }

Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }

github-actions · 2025-08-14T12:48:08Z

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

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.

isra-fel · 2025-10-31T06:39:07Z

/azp run

azure-pipelines · 2025-10-31T06:39:14Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

isra-fel · 2025-10-31T07:09:31Z

/azp run

azure-pipelines · 2025-10-31T07:09:37Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

naveedaz · 2026-02-10T05:32:37Z

/azp run

azure-pipelines · 2026-02-10T05:32:44Z

Commenter does not have sufficient privileges for PR 28268 in repo Azure/azure-powershell

naveedaz · 2026-02-10T05:34:21Z

@mishapos and @skylathadani-ms can you guys review too?

Copilot

Pull request overview

Copilot reviewed 112 out of 112 changed files in this pull request and generated 7 comments.

Copilot · 2026-02-10T05:43:11Z

src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md

+Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }
 ```


Example uses a likely typo in the static site name ("taticweb00"), which will cause copy/paste failures. Please correct it to the intended site name used elsewhere in the examples.

Copilot · 2026-02-10T05:43:11Z

src/Websites/Websites/help/Update-AzStaticWebAppUser.md

+Description for update a user entry with the listed roles



The synopsis/description text is grammatically incorrect ("Description for update a user entry...") and reads like an unedited template. Please change it to a proper verb form (e.g., "Updates a user entry...") for the reference help.

Copilot · 2026-02-10T05:43:11Z

src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs

+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code


Minor typo in the header comment: missing space after the period in "Code Generator.Changes". Please add the missing space to keep the generated header readable.

Suggested change

// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code

// Code generated by Microsoft (R) AutoRest Code Generator. Changes may cause incorrect behavior and will be lost if the code

Copilot · 2026-02-10T05:43:12Z

src/Websites/Websites/help/Az.Websites.md

+Description for update a new static site in an existing resource group, or update an existing static site.

 ### [Update-AzStaticWebAppUser](Update-AzStaticWebAppUser.md)
-Description for Updates a user entry with the listed roles
+Description for update a user entry with the listed roles


This synopsis line is grammatically incorrect and misleading ("update a new static site..."). Please adjust it to accurately describe the cmdlet (it updates an existing static site; it doesn't "update a new" one).

Copilot · 2026-02-10T05:43:12Z

src/Websites/Websites/Az.Websites.psd1

 # Modules that must be imported into the global environment prior to importing this module
-RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.2.0'; })
+RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.1.1'; })



Module dependency versions are inconsistent across the Websites module artifacts: the manifest requires Az.Accounts 5.1.1, but the AutoRest README states 2.7.5+ and the .nuspec depends on 2.7.5. Please align these (and ensure the chosen minimum is reflected consistently in psd1, nuspec, and README) to avoid install/import mismatches for users.

Copilot · 2026-02-10T05:43:12Z

src/Websites/Websites/ChangeLog.md

        - Additional information about change #1
 -->
 ## Upcoming Release
+* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).


The Upcoming Release entry is too generic for users and doesn't clearly describe the actual change (AutoRest v4 migration) or reference the related announcement PRs/issues. Please update the entry to explicitly state what's changing for Az.Websites users and include relevant issue/PR references.

Copilot · 2026-02-10T05:43:12Z

src/Websites/Websites/help/Az.Websites.md


 ### [New-AzStaticWebApp](New-AzStaticWebApp.md)
-Description for Creates a new static site in an existing resource group, or updates an existing static site.
+Description for create a new static site in an existing resource group, or create an existing static site.


This description is grammatically incorrect and also changes the meaning: "or create an existing static site" should be "or update an existing static site". Please fix the synopsis/description text so it accurately reflects the cmdlet behavior.

upgrade websites module to autorest v4

3edff75

Pan-Qi added 3 commits July 30, 2025 01:04

fix identity

1111001

fix directive

abfe591

fix directive & add changelog

345bc0f

Pan-Qi force-pushed the bernard-migrate-websites-to-v4 branch from bf40356 to 345bc0f Compare July 30, 2025 14:36

suppress breaking change

0205cbd

Pan-Qi marked this pull request as ready for review August 6, 2025 13:51

Copilot AI review requested due to automatic review settings August 6, 2025 13:51

Copilot AI reviewed Aug 6, 2025

View reviewed changes

Pan-Qi added the Contains Breaking Change This PR contains breaking change label Aug 14, 2025

isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025

Pan-Qi mentioned this pull request Oct 7, 2025

breaking change announcement for Websites module #28650

Merged

6 tasks

update unified changelog

925fde5

update unified changelog

b69cbde

isra-fel assigned Pan-Qi Jan 29, 2026

isra-fel added this to the Az 16.0.0 (TBD) milestone Jan 29, 2026

naveedaz approved these changes Feb 10, 2026

View reviewed changes

naveedaz requested review from Copilot, mishapos and skylathadani-ms February 10, 2026 05:32

Copilot started reviewing on behalf of naveedaz February 10, 2026 05:35 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

	Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' \| New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }
	Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' \| New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' }

	// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
	// Code generated by Microsoft (R) AutoRest Code Generator. Changes may cause incorrect behavior and will be lost if the code

Conversation

Pan-Qi commented Jul 24, 2025 • edited by JiaSeng-v Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Jul 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 14, 2025

Uh oh!

isra-fel commented Oct 31, 2025

Uh oh!

azure-pipelines bot commented Oct 31, 2025

Uh oh!

isra-fel commented Oct 31, 2025

Uh oh!

azure-pipelines bot commented Oct 31, 2025

Uh oh!

naveedaz commented Feb 10, 2026

Uh oh!

azure-pipelines bot commented Feb 10, 2026

Uh oh!

naveedaz commented Feb 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Pan-Qi commented Jul 24, 2025 •

edited by JiaSeng-v

Loading