[Draft] Support az what-if - #32138
Draft
Shiying Chen (MoChilia) wants to merge 20 commits into
Draft
Conversation
Shiying Chen (MoChilia)
requested review from
Yishi Wang (evelyn-ys),
Jiashuo Li (jiasli) and
Xing Zhou (zhoxing-ms)
as code owners
September 18, 2025 02:00
️✔️AzureCLI-FullTest
|
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| sql server create | cmd sql server create added parameter what_if |
⚠️ util
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| what-if | cmd what-if added |
⚠️ vm
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| vm create | cmd vm create 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 introduces a new az what-if command that allows users to simulate Azure CLI scripts and visualize infrastructure changes before execution. The command analyzes a script file and sends it to an external service for what-if analysis.
- Adds a new
what-ifcommand to the util module - Implements script parsing and external API integration for what-if simulation
- Provides help documentation and parameter definitions for the new command
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-cli/azure/cli/command_modules/util/custom.py | Core implementation of the show_what_if function that reads scripts and calls external service |
| src/azure-cli/azure/cli/command_modules/util/commands.py | Command registration for the new what-if command |
| src/azure-cli/azure/cli/command_modules/util/_params.py | Parameter definition for the script path argument |
| src/azure-cli/azure/cli/command_modules/util/_help.py | Help documentation and usage examples for the command |
| src/azure-cli/azure/cli/command_modules/util/tests/latest/test_whatif_script.sh | Test script file for the what-if functionality |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Shiying Chen (MoChilia)
requested review from
Hang (bebound),
Zhiyi Huang (calvinhzy),
Yu Chen (jsntcy),
kai ru (kairu-ms) and
Ethan Yang (necusjz)
as code owners
September 22, 2025 07:46
* Add what if feature * Update src/azure-cli-core/azure/cli/core/commands/__init__.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * minor fix * Update what_if.py --------- Co-authored-by: ZelinWang <zelinwang@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Shiying Chen (MoChilia)
requested a review
from Julie Zhu (yanzhudd)
as a code owner
September 22, 2025 08:07
Shiying Chen (MoChilia)
marked this pull request as draft
September 22, 2025 08:11
Member
Author
|
/azp run |
|
Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command. |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
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 what-if--what-ifDescription
A new Azure CLI command for creating a sandboxed what-if simulation of Azure CLI scripts to visualize infrastructure changes before execution.
--script-path: Specify the path to a script file containing Azure CLI commands to be executed.--no-pretty-print: Disable pretty-printing of the output.Include pr #32131 contributed by ZelinWang (@wangzelin007)
az vm --what-ifaz sql --what-ifTesting Guide
Ensure you have run
az loginaz what-if --script-path "/path/to/your/script.shaz what-if --script-path "/path/to/your/script.sh" --subscription 00000000-0000-0000-0000-000000000000History Notes
[What-if]
az what-if: Supportaz what-if[What-if]: Support
--what-ifThis 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.