-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Simplify change log for batch #28849
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The changelog entry lacks detail about what changes users should expect from this API upgrade. According to the coding guidelines for ChangeLog.md files (CodingGuidelineID: 1000002), entries should be written from the user's perspective and explain what changed and how it affects their usage. The removed content documented significant breaking changes including removal of commands (Get-AzBatchRemoteDesktopProtocolFile, certificate-related commands), removal of parameters (CloudServiceConfiguration, CertificateReferences, etc.), and new features (new enum values, new properties). Users upgrading will need this information to understand the impact. Consider either: (1) restoring the detailed changelog entries, or (2) adding a reference to the migration guide at https://go.microsoft.com/fwlink/?linkid=2333229 mentioned in version 3.7.1, such as: '* Upgraded API version from 2022-10-01 to 2024-07-01. For details on breaking changes, please refer to https://go.microsoft.com/fwlink/?linkid=2333229'