{Compute} az vm image list: Fall back on invalid image alias doc#33429
Merged
yanzhudd merged 1 commit intoJun 29, 2026
Conversation
rohan-patnaik
requested review from
NoriZC,
teresaritorto and
yanzhudd
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @rohan-patnaik, |
️✔️AzureCLI-BreakingChangeTest
|
microsoft-github-policy-service
Bot
added
the
customer-reported
Contributor
|
Thank you for your contribution @rohan-patnaik! We will review the pull request and get back to you soon. |
microsoft-github-policy-service
Bot
added
Compute
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a fallback to the local VM image alias doc when the remote alias document returns invalid JSON, and introduces a regression test to cover that scenario.
Changes:
- Handle invalid JSON from the remote alias doc by logging a warning and falling back to the embedded local alias doc.
- Add a unit test that mocks a 200 response with non-JSON content and verifies the fallback behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/azure-cli/azure/cli/command_modules/vm/_actions.py |
Adds JSON parsing error handling and local-copy fallback when remote content is not valid JSON. |
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_image.py |
Adds a test ensuring invalid JSON from the alias doc endpoint falls back to local aliases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| dic = json.loads(response.content.decode()) | ||
| try: | ||
| dic = json.loads(response.content.decode()) | ||
| except json.JSONDecodeError as ex: |
|
|
||
| images = load_images_from_aliases_doc(cli_ctx) | ||
|
|
||
| self.assertEqual(images[0]['urnAlias'], 'AzureLinux4') |
Collaborator
|
vm |
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>
|
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
yanzhudd
changed the title
az vm image: Fall back on invalid image alias doc
yanzhudd
changed the title
az vm image: Fall back on invalid image alias docaz vm image list: Fall back on invalid image alias doc
yanzhudd
approved these changes
Jun 29, 2026
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.
Fixes #33162
Summary
This makes
az vm image listfall back to the bundled image alias document when the remote alias document returns HTTP 200 but the body is not valid JSON.Why
Today that path raises a raw
JSONDecodeError, which makes the command fail with a Python traceback. If the alias endpoint is intercepted or returns a small error body, the CLI should behave like the existing fetch-failure paths and use the local alias copy instead.Test plan
PYTHONPATH=src/azure-cli:src/azure-cli-core .venv/bin/python -m py_compile src/azure-cli/azure/cli/command_modules/vm/_actions.py src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_image.pygit diff --checkNote: I also tried the focused pytest for the new test, but the local venv is missing
vcr, required byazure-cli-testsdkduring test collection.