Skip to content

Conversation

Pan-Qi
Copy link
Contributor

@Pan-Qi Pan-Qi commented Jul 24, 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.

@Pan-Qi Pan-Qi force-pushed the bernard-migrate-websites-to-v4 branch from bf40356 to 345bc0f Compare July 30, 2025 14:36
@Pan-Qi Pan-Qi marked this pull request as ready for review August 6, 2025 13:51
@Copilot Copilot AI review requested due to automatic review settings August 6, 2025 13:51
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 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

### 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' }
Copy link

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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' }

Copilot uses AI. Check for mistakes.

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

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 isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 Contains Breaking Change This PR contains breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants