Updated apiVersion for Az.ApiManagement from 2021-08-01 to 2022-08-01 #28912
Conversation
* Set a fixed `apiVersion` to "2024-05-01". * Adjusted the logic to use the new `apiVersion` instead of the client’s version. * Ensured proper tracing functionality remains intact.
… management - Introduced extension methods for `IProductWikisOperations` to facilitate Wiki management for products in API Management. - Added synchronous and asynchronous methods for listing Wikis, including pagination support. - Enhanced usability by providing cancellation token support for asynchronous operations.
* Updated the API version for Az.ApiManagement from `2021-08-01` to `2022-08-01` to ensure compatibility with the latest features and improvements.
* Updated `ModuleVersion` in `Az.ApiManagement.psd1` to `4.2.0` * Updated change log to reflect the new version and API updates * This resolves compatibility issues with newer Azure API Management service instances
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the API version for the Az.ApiManagement module from 2021-08-01 to 2022-08-01 to resolve compatibility issues with Azure services that no longer support the older API version.
Key Changes:
- Updated API version reference from 2021-08-01 to 2022-08-01 in the ApiManagement module
- Added changelog entry documenting the API version upgrade
| #### Az.ApiManagement 4.0.0 | ||
| * Upgraded API version from 2021-08-01 to 2022-08-01 |
There was a problem hiding this comment.
The changelog entry should reference the related GitHub issue that prompted this change. Per the coding guidelines, issue references should be included for all changes, especially those addressing bugs or compatibility issues. Add a reference to the issue number (e.g., [#12345]) at the end of the entry.
| * Upgraded API version from 2021-08-01 to 2022-08-01 | ||
|
|
There was a problem hiding this comment.
The changelog entry lacks user-focused context explaining why this change matters. According to the coding guidelines, entries should be written from the user's perspective and explain the impact. Consider adding a sub-bullet that explains this resolves compatibility issues with Azure services that no longer support the 2021-08-01 API version.
|
Thank you for your contribution @baswijdenes! We will review the pull request and get back to you soon. |
* Set up the project structure. * Prepare for future code changes and enhancements.
- Regenerated SDK using AutoRest from 2022-08-01 Azure REST API specs - Updated all test session recordings (plain and base64-encoded API versions) - Updated ChangeLog with API version upgrade details - Resolves compatibility issues with newer Azure API Management service instances
* Removed redundant code blocks to enhance readability. * Organized imports and dependencies for better maintainability. * Ensured consistent formatting across all files.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
2 participants
Description
I've updated the apiversion for the Az.ApiManagement module from 2021-08-01 to 2022-08-01 because I received this error using the module:
{"error":{"code":"IncorrectVersionParameter","message":"The service is configured to allow management requests only with the following api-version values: 2022-08-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview, 2024-10-01-preview, 2025-03-01-preview, 2025-09-01-preview","details":null,"innerError":null}}Unfortunately, I could not update to an even newer stable version.
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.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.