[lab] Fix #7903 Help updated (az lab vm): Add double quotes with escape character to --expand#32354
Merged
Merged
Conversation
Adding double quotes with escape character, to avoid issue with documentation when user copy/paste the command.
️✔️AzureCLI-FullTest
|
azure-client-tools-bot-prd
Bot
added this to the
November 2025 (2025-11-18)❗ Breaking change release ❗ milestone
️✔️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>
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the help text examples for the --expand parameter in three Azure DevTest Lab VM commands by adding escaped double quotes around the example values. The change modifies the example from 'properties($expand=...)' to '\"properties($expand=...)\"'.
- Updated help text formatting for the
--expandparameter example - Applied consistently across three VM-related command files
- Added escaped double quotes to the query example value
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/azure-cli/azure/cli/command_modules/lab/aaz/latest/lab/vm/_wait.py |
Updated --expand help text example with escaped double quotes |
src/azure-cli/azure/cli/command_modules/lab/aaz/latest/lab/vm/_show.py |
Updated --expand help text example with escaped double quotes |
src/azure-cli/azure/cli/command_modules/lab/aaz/latest/lab/vm/_list.py |
Updated --expand help text example with escaped double quotes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kairu-ms
approved these changes
Nov 3, 2025
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
aupetit-ms
changed the title
aupetit-ms
changed the title
--expand
Contributor
Author
|
/azp run |
|
Commenter does not have sufficient privileges for PR 32354 in repo Azure/azure-cli |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
aupetit-ms
changed the title
--expandaz lab vm): Add double quotes with escape character to --expand
Contributor
Author
|
/azp run |
|
Commenter does not have sufficient privileges for PR 32354 in repo Azure/azure-cli |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
The format of the PR title is incorrect. This PR doesn't qualify as a customer-facing change either. It should start with See https://github.com/Azure/azure-cli/tree/dev/doc/authoring_command_modules#submitting-pull-requests |
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.
Add double quotes with escape character, to avoid issue with documentation when user copy/paste the command.
Related command
az lab vm show --helpaz lab vm list --helpaz lab vm wait --helpDescription
This PR is here to fix this issue:
Using az lab vm show to view artifacts doesn't work
The
--expandhelp text have been updated with double quotes to help people when they copy/paste it into their terminal.Testing Guide
Run these commands and look at the output displayed:
az lab vm show --helpaz lab vm list --helpaz lab vm wait --helpBefore:
--expand : Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSched ule)'.After:
--expand : Specify the $expand query. Example: '"properties($expand=artifacts,computeVm,networkInterface,applicableSchedu le)"'.This 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.