Skip to content

[Az.Portal] Api Version Upgrade #27035

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

Merged
merged 9 commits into from
Jan 26, 2025

Conversation

notyashhh
Copy link
Member

@notyashhh notyashhh commented Jan 23, 2025

Description

This PR updates Az.Portal to a newer API version, fixing the parameter conflict in both New-AzPortalDashboard and Set-AzPortalDashboard cmdlets. Specifically, it renames the parameter from -Dashboard to -Resource, and resolves schema changes introduced in the new spec. These updates address issues that arose when attempting to create dashboards using the old 2019 API version.

ICM addressed: https://portal.microsofticm.com/imp/v5/incidents/details/570416461/summary

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • For SDK-based development mode, 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.
    • For autorest-based development mode, include the changelog in the PR description.
    • 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

azure-client-tools-bot-prd bot commented Jan 23, 2025

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
⚠️Az.Portal
️✔️Build
️✔️PowerShell Core - Windows
️✔️Breaking Change Check
️✔️PowerShell Core - Windows
⚠️Signature Check
⚠️PowerShell Core - Windows
Type Cmdlet Description Remediation
⚠️ Get-AzPortalDashboard Get-AzPortalDashboard Changes the ConfirmImpact but does not set the SupportsShouldProcess property to true in the cmdlet attribute. Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue
⚠️ Get-AzPortalDashboard Get-AzPortalDashboard changes the confirm impact. Please ensure that the change in ConfirmImpact is justified Verify that ConfirmImpact is changed appropriately by the cmdlet. It is very rare for a cmdlet to change the ConfirmImpact.
️✔️Help Example Check
️✔️PowerShell Core - Windows
️✔️Help File Existence Check
️✔️PowerShell Core - Windows
⚠️File Change Check
⚠️PowerShell Core - Windows
Type Cmdlet Description Remediation
⚠️ It is required to update ChangeLog.md if you want to release a new version for Az.Portal. Add a changelog record under Upcoming Release section with past tense.
️✔️UX Metadata Check
️✔️PowerShell Core - Windows
️✔️Test
️✔️PowerShell Core - Linux
️✔️PowerShell Core - MacOS
️✔️PowerShell Core - Windows

@notyashhh notyashhh requested a review from YanaXu January 23, 2025 03:47
@notyashhh notyashhh requested a review from YanaXu January 23, 2025 06:40
@notyashhh notyashhh requested a review from YanaXu January 23, 2025 07:00
YanaXu
YanaXu previously approved these changes Jan 23, 2025
Copy link

‼️ DO NOT MERGE THIS PR ‼️
This PR was labeled "Do Not Merge" because it contains code change that cannot be merged. Please contact the reviewer for more information.

@YanaXu YanaXu self-assigned this Jan 24, 2025
@YanaXu YanaXu merged commit 7489007 into Azure:generation Jan 26, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants