-
Notifications
You must be signed in to change notification settings - Fork 4k
[Az.Dns] Update generation tool version: autorest.powershell v3->v4 #28318
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
base: main
Are you sure you want to change the base?
Conversation
Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
To the author of the pull request, |
There was a problem hiding this 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 updates the Azure DNS module's AutoRest PowerShell generation tool from version 3 to version 4. The upgrade involves regenerating the DNSSEC configuration cmdlets and updating related documentation files to reflect changes in the generated code structure and API signatures.
- Updated AutoRest PowerShell generation tool from v3 to v4
- Regenerated DNSSEC configuration cmdlets with updated API models and type signatures
- Updated help documentation to reflect new model types and simplified descriptions
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
tools/StaticAnalysis/Exceptions/Az.Dns/BreakingChangeIssues.csv | Added breaking change exceptions for type signature changes in DNSSEC cmdlets |
src/Dns/Dns/help/*.md | Updated help documentation with simplified descriptions and new model types |
src/Dns/Dns/Az.Dns.psd1 | Updated generation date metadata |
src/Dns/Dns.sln | Updated project GUID references for regenerated AutoRest project |
src/Dns/Dns.Autorest/generate-info.json | Updated generation ID for new AutoRest run |
src/Dns/Dns.Autorest/docs/*.md | Updated AutoRest documentation with new module GUID and simplified descriptions |
src/Dns/Dns.Autorest/README.md | Removed v3-specific configuration directives for AutoRest |
Comments suppressed due to low confidence (1)
src/Dns/Dns.Autorest/README.md:1
- The removal of AutoRest v3 configuration is correct for the upgrade to v4, but according to the coding guidelines, this change should be validated by performing a full build and manual testing of the DNSSEC cmdlets to ensure the v4 generation produces working PowerShell commands that can successfully interact with Azure DNS services.
<!-- region Generated -->
@@ -0,0 +1,10 @@ | |||
"Module","ClassName","Target","Severity","ProblemId","Description","Remediation" | |||
"Az.Dns","Get-AzDnsDnssecConfig","Get-AzDnsDnssecConfig","0","3000","The type of property 'SigningKey' of type 'Microsoft.Azure.PowerShell.Cmdlets.Dns.Models.Api20230701Preview.IDnssecConfig' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Dns.Models.ISigningKey' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Dns.Models.ISigningKey]'.","Change the type of property 'SigningKey' back to 'Microsoft.Azure.PowerShell.Cmdlets.Dns.Models.ISigningKey'." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This breaking change exception indicates a significant API change where SigningKey property changed from a single object to a collection. According to the coding guidelines, breaking changes in AutoRest-generated modules should be carefully validated through manual testing scenarios to ensure the new collection-based API works correctly with real Azure DNS DNSSEC configurations.
Copilot uses AI. Check for mistakes.
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.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.md
and reviewed the following information:ChangeLog.md
file(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
.## Upcoming Release
header in the past tense.ChangeLog.md
if no new release is required, such as fixing test case only.