Skip to content

Conversation

@dolauli
Copy link
Contributor

@dolauli dolauli commented Nov 10, 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

Copilot AI review requested due to automatic review settings November 10, 2025 12:47
@azure-client-tools-bot-prd
Copy link

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

Copy link
Contributor

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 simplifies the Batch module's changelog for the upcoming release by consolidating detailed breaking change entries into a single API version upgrade note. The detailed changes (removal of commands, parameters, and properties, plus addition of new features) have been replaced with a concise statement about upgrading from API version 2022-10-01 to 2024-07-01.

  • Removed 26 lines of detailed breaking change documentation
  • Added 1 line noting the API version upgrade

* Added property `SkipWithdrawFromVNet` to `PSJobNetworkConfiguration` model.
* Added property `SecurityProfile` to `PSManagedDisk` model.
* Added property `ContainerHostBatchBindMounts` to `PSTaskContainerSettings` model.
* Upgraded API version from 2022-10-01 to 2024-07-01.
Copy link

Copilot AI Nov 10, 2025

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'

Copilot generated this review using guidance from repository custom instructions.
@vidai-msft vidai-msft merged commit 36fe8e3 into main Nov 11, 2025
18 checks passed
@vidai-msft vidai-msft deleted the dolauli-patch-4 branch November 11, 2025 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants