{Compute} az vmss: Migrate commands to aaz-based implementation
#32788
Conversation
william051200
requested review from
jsntcy,
wangzelin007,
yanzhudd and
zhoxing-ms
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
|
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
added
the
Compute
There was a problem hiding this comment.
Pull request overview
Migrates selected az vmss commands from azure.mgmt.compute SDK usage to AAZ-based implementations, aligning VMSS command behavior with the ongoing AAZ migration in the vm command module.
Changes:
- Switch VMSS retrieval in
list-instance-connection-infoandlist-instance-public-ipsto use AAZShowoutput (dict-based access). - Move
vmss list-instance-*command registrations to the non-SDKvmsscommand group. - Update flex-VMSS detection helper to use dict-style access (
orchestrationMode).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
src/azure-cli/azure/cli/command_modules/vm/custom.py |
Updates VMSS connection info + public IP listing flows to use AAZ VMSS Show and dict traversal. |
src/azure-cli/azure/cli/command_modules/vm/commands.py |
Rehomes vmss list-instance-* custom command registrations to a separate vmss group block. |
src/azure-cli/azure/cli/command_modules/vm/_vm_utils.py |
Changes flex VMSS detection helper to assume dict-shaped VMSS objects. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| for ip in primary_nic_config.ip_configurations: | ||
| if ip.load_balancer_inbound_nat_pools: | ||
| res_id = ip.load_balancer_inbound_nat_pools[0].id | ||
| for ip in primary_nic_config.get('ipConfigurations'): |
There was a problem hiding this comment.
primary_nic_config.get('ipConfigurations') can return None when the key is missing, which will raise a TypeError when iterating. Use a default empty list (or guard) so the command returns the intended ResourceNotFoundError/CLIError instead of crashing when ip configurations are absent.
| for ip in primary_nic_config.get('ipConfigurations'): | |
| for ip in primary_nic_config.get('ipConfigurations') or []: |
| from azure.mgmt.core.tools import parse_resource_id | ||
| from .aaz.latest.vmss import Show as VmssShow | ||
|
|
There was a problem hiding this comment.
This code imports and calls the generated aaz.latest.vmss.Show directly. Elsewhere in this module the wrapper operations.vmss.VMSSShow is used to normalize the output and resolve known flatten conflicts (e.g., the type field). Please switch to VMSSShow here as well to keep behavior consistent and avoid potential output-shape regressions.
| command_args = { | ||
| 'resource_group': resource_group_name, | ||
| 'vm_scale_set_name': vm_scale_set_name | ||
| } | ||
| vmss = VmssShow(cli_ctx=cmd.cli_ctx)(command_args=command_args) |
There was a problem hiding this comment.
This function now calls aaz.latest.vmss.Show (2025-04-01) instead of the mgmt-plane SDK get used previously. This changes the request api-version in scenario tests/recordings (many current recordings show api-version=2024-11-01 for the VMSS GET), so playback will likely fail until the relevant recordings are re-generated.
| from .aaz.latest.vmss import Show as VmssShow | ||
| ListInstancePublicIps = import_aaz_by_profile(cmd.cli_ctx.cloud.profile, "vmss").ListInstancePublicIps |
There was a problem hiding this comment.
Same as above: prefer using the operations.vmss.VMSSShow wrapper rather than calling aaz.latest.vmss.Show directly, to avoid known flatten conflicts and keep VMSS show output consistent across commands.
| def raise_unsupported_error_for_flex_vmss(vmss, error_message): | ||
| if hasattr(vmss, 'orchestration_mode') and vmss.orchestration_mode \ | ||
| and vmss.orchestration_mode.lower() == 'flexible': | ||
| if vmss.get('orchestrationMode', '').lower() == 'flexible': |
There was a problem hiding this comment.
raise_unsupported_error_for_flex_vmss now assumes vmss is a dict and will throw AttributeError if a caller passes an SDK model (or None). The previous implementation supported SDK objects via attribute access. Consider keeping it compatible with both representations (dict and SDK object) so it remains a safe helper across the module.
| if vmss.get('orchestrationMode', '').lower() == 'flexible': | |
| # Support both dict-based representations and SDK model objects (or None) | |
| if not vmss: | |
| return | |
| orchestration_mode = None | |
| # Dict-like representation | |
| if isinstance(vmss, dict): | |
| orchestration_mode = vmss.get('orchestrationMode') | |
| else: | |
| # SDK model or other object representation | |
| orchestration_mode = getattr(vmss, 'orchestration_mode', None) | |
| if orchestration_mode is None: | |
| orchestration_mode = getattr(vmss, 'orchestrationMode', None) | |
| if isinstance(orchestration_mode, str) and orchestration_mode.lower() == 'flexible': |
4 participants
Related command
az vmss list-instance-connection-infoaz vmss list-instance-public-ipsaz vmss list-instancesDescription
Migration from mgmt.compute to aaz-based
Testing Guide
History Notes
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.