[Draft] Support --what-if argument
#32131
Open
Conversation
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
wangzelin007
requested review from
bebound,
calvinhzy,
evelyn-ys,
jiasli,
jsntcy,
kairu-ms,
necusjz,
yanzhudd and
zhoxing-ms
as code owners
️✔️AzureCLI-FullTest
|
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| network vnet create | cmd network vnet create added parameter export_bicep |
||
| network vnet create | cmd network vnet create added parameter what_if |
||
| network vnet update | cmd network vnet update added parameter export_bicep |
||
| network vnet update | cmd network vnet update added parameter what_if |
⚠️ storage
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| storage account create | cmd storage account create added parameter export_bicep |
||
| storage account create | cmd storage account create added parameter what_if |
||
| storage account network-rule add | cmd storage account network-rule add added parameter export_bicep |
||
| storage account network-rule add | cmd storage account network-rule add added parameter what_if |
||
| storage container create | cmd storage container create added parameter export_bicep |
||
| storage container create | cmd storage container create added parameter what_if |
||
| storage share create | cmd storage share create added parameter export_bicep |
||
| storage share create | cmd storage share create added parameter what_if |
⚠️ vm
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| vm create | cmd vm create added parameter export_bicep |
||
| vm create | cmd vm create added parameter what_if |
||
| vm disk attach | cmd vm disk attach added parameter export_bicep |
||
| vm disk attach | cmd vm disk attach added parameter what_if |
||
| vm disk detach | cmd vm disk detach added parameter export_bicep |
||
| vm disk detach | cmd vm disk detach added parameter what_if |
||
| vm nic remove | cmd vm nic remove added parameter export_bicep |
||
| vm nic remove | cmd vm nic remove added parameter what_if |
||
| vm update | cmd vm update added parameter export_bicep |
||
| vm update | cmd vm update added parameter what_if |
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 adds support for the --what-if argument to Azure CLI commands, allowing users to preview changes before execution. The implementation includes a new what-if service client and parameter integration across VM and SQL command modules.
- Creates a new what-if module with Azure authentication and service communication
- Adds
--what-ifparameter support to VM and SQL command creation/update operations - Implements command interception logic to handle what-if mode execution
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-cli-core/azure/cli/core/what_if.py | New module implementing what-if service client with Azure authentication |
| src/azure-cli-core/azure/cli/core/commands/parameters.py | Adds get_what_if_type() function for parameter definition |
| src/azure-cli-core/azure/cli/core/commands/init.py | Implements command interception and what-if execution logic |
| src/azure-cli/azure/cli/command_modules/vm/_params.py | Adds what-if parameter to VM create and update commands |
| src/azure-cli/azure/cli/command_modules/vm/custom.py | Updates VM create function signature to accept what-if parameter |
| src/azure-cli/azure/cli/command_modules/sql/_params.py | Adds what-if parameter to SQL server create command |
| src/azure-cli/azure/cli/command_modules/sql/custom.py | Updates SQL server create function signature to accept what-if parameter |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
zhoxing-ms
reviewed
Sep 17, 2025
wangzelin007
force-pushed
the
wzl/add-what-if
branch
from
20c2630 to
3f86e44
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Description
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.