{Compute} az vm create: Fix API version when fetching virtual network resource#31945
Merged
{Compute} az vm create: Fix API version when fetching virtual network resource#31945
az vm create: Fix API version when fetching virtual network resource#31945Conversation
️✔️AzureCLI-FullTest
|
necusjz
requested review from
jsntcy,
wangzelin007,
yanzhudd and
zhoxing-ms
as code owners
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
requested review from
kairu-ms and
yonzhan
microsoft-github-policy-service
bot
added
the
Compute
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an API version compatibility issue in the az vm create command where the resource SDK was upgraded to use API version 2025-01-01 for virtual network operations, but the server doesn't support this version yet. The fix adds a fallback mechanism to use the CLI's supported API version when the default fails.
Key changes:
- Added fallback logic to retry virtual network subnet existence checks with CLI-specific API version
- Imports the network command module to get the supported API version for virtual networks
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| check_existence(cmd.cli_ctx, subnet, rg, 'Microsoft.Network', 'subnets', vnet, 'virtualNetworks') | ||
|
|
||
| if not subnet_exists: | ||
| from azure.cli.command_modules.network.aaz.latest.network.vnet import Show as VNetShow |
There was a problem hiding this comment.
The import statement is placed inside a conditional block that only executes when subnet doesn't exist. Consider moving this import to the top of the file to avoid repeated import overhead if this code path is executed multiple times.
Suggested change
| from azure.cli.command_modules.network.aaz.latest.network.vnet import Show as VNetShow |
|
|
||
| if not subnet_exists: | ||
| from azure.cli.command_modules.network.aaz.latest.network.vnet import Show as VNetShow | ||
| cli_api_version = VNetShow._aaz_info["version"] |
There was a problem hiding this comment.
Accessing private attributes (indicated by underscore prefix) like _aaz_info creates a tight coupling and may break if the internal structure changes. Consider using a public API or method to retrieve the version information.
Suggested change
| cli_api_version = VNetShow._aaz_info["version"] | |
| # Use public API to get version if available | |
| if hasattr(VNetShow, "get_version") and callable(getattr(VNetShow, "get_version")): | |
| cli_api_version = VNetShow.get_version() | |
| elif hasattr(VNetShow, "version"): | |
| cli_api_version = VNetShow.version | |
| else: | |
| # Fallback to private attribute with warning | |
| logger.warning("Accessing private attribute _aaz_info['version']. Consider updating to use a public API if available.") | |
| cli_api_version = VNetShow._aaz_info["version"] |
yanzhudd
approved these changes
Aug 18, 2025
3 tasks
kairu-ms
approved these changes
Aug 18, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related command
az vm createDescription
Inspired by #31868
IcM: 656299018
In
az vm createcommand, we rely on the resource SDK package to determine which API version is used when fetching a virtual network resource from the backend. However, the resource package was upgraded in #31449. And the new API version being used is 2025-01-01 which is not yet supported by server side.The error message is:
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.