Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from ._show import *
from ._simulate_eviction import *
from ._start import *
from ._stop import *
from ._update import *
from ._update_domain_walk import *
from ._wait import *
187 changes: 187 additions & 0 deletions src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vmss/_stop.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#
# Code generated by aaz-dev-tools
# --------------------------------------------------------------------------------------------

# pylint: skip-file
# flake8: noqa

from azure.cli.core.aaz import *


class Stop(AAZCommand):
"""Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.
"""

_aaz_info = {
"version": "2024-11-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/poweroff", "2024-11-01"],
]
}

AZ_SUPPORT_NO_WAIT = True

def _handler(self, command_args):
super()._handler(command_args)
return self.build_lro_poller(self._execute_operations, None)

_args_schema = None

@classmethod
def _build_arguments_schema(cls, *args, **kwargs):
if cls._args_schema is not None:
return cls._args_schema
cls._args_schema = super()._build_arguments_schema(*args, **kwargs)

# define Arg Group ""

_args_schema = cls._args_schema
_args_schema.resource_group = AAZResourceGroupNameArg(
required=True,
)
_args_schema.vm_scale_set_name = AAZStrArg(
options=["--vm-scale-set-name"],
help="The name of the VM scale set.",
required=True,
id_part="name",
)
_args_schema.skip_shutdown = AAZBoolArg(
options=["--skip-shutdown"],
help="The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified",
)

# define Arg Group "VmInstanceIDs"

_args_schema = cls._args_schema
_args_schema.instance_ids = AAZListArg(
options=["--instance-ids"],
arg_group="VmInstanceIDs",
help="The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.",
)

instance_ids = cls._args_schema.instance_ids
instance_ids.Element = AAZStrArg()
return cls._args_schema

def _execute_operations(self):
self.pre_operations()
yield self.VirtualMachineScaleSetsPowerOff(ctx=self.ctx)()
self.post_operations()

@register_callback
def pre_operations(self):
pass

@register_callback
def post_operations(self):
pass

class VirtualMachineScaleSetsPowerOff(AAZHttpOperation):
CLIENT_TYPE = "MgmtClient"

def __call__(self, *args, **kwargs):
request = self.make_request()
session = self.client.send_request(request=request, stream=False, **kwargs)
if session.http_response.status_code in [202]:
return self.client.build_lro_polling(
self.ctx.args.no_wait,
session,
self.on_200,
self.on_error,
lro_options={"final-state-via": "location"},
path_format_arguments=self.url_parameters,
)
if session.http_response.status_code in [200]:
return self.client.build_lro_polling(
self.ctx.args.no_wait,
session,
self.on_200,
self.on_error,
lro_options={"final-state-via": "location"},
path_format_arguments=self.url_parameters,
)

return self.on_error(session.http_response)

@property
def url(self):
return self.client.format_url(
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff",
**self.url_parameters
)

@property
def method(self):
return "POST"

@property
def error_format(self):
return "ODataV4Format"

@property
def url_parameters(self):
parameters = {
**self.serialize_url_param(
"resourceGroupName", self.ctx.args.resource_group,
required=True,
),
**self.serialize_url_param(
"subscriptionId", self.ctx.subscription_id,
required=True,
),
**self.serialize_url_param(
"vmScaleSetName", self.ctx.args.vm_scale_set_name,
required=True,
),
}
return parameters

@property
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"skipShutdown", self.ctx.args.skip_shutdown,
),
**self.serialize_query_param(
"api-version", "2024-11-01",
required=True,
),
}
return parameters

@property
def header_parameters(self):
parameters = {
**self.serialize_header_param(
"Content-Type", "application/json",
),
}
return parameters

@property
def content(self):
_content_value, _builder = self.new_content_builder(
self.ctx.args,
typ=AAZObjectType,
typ_kwargs={"flags": {"client_flatten": True}}
)
_builder.set_prop("instanceIds", AAZListType, ".instance_ids")

instance_ids = _builder.get(".instanceIds")
if instance_ids is not None:
instance_ids.set_elements(AAZStrType, ".")

return self.serialize_content(_content_value)

def on_200(self, session):
pass


class _StopHelper:
"""Helper class for Stop"""


__all__ = ["Stop"]
3 changes: 2 additions & 1 deletion src/azure-cli/azure/cli/command_modules/vm/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,8 @@ def load_command_table(self, _):
g.custom_command('identity remove', 'remove_vmss_identity', validator=process_remove_identity_namespace, is_preview=True)
g.custom_show_command('identity show', 'show_vmss_identity')

g.custom_command('stop', 'stop_vmss', supports_no_wait=True, validator=process_vm_vmss_stop)

with self.command_group('vmss', compute_vmss_sdk, operation_group='virtual_machine_scale_sets') as g:
g.custom_command('application set', 'set_vmss_applications', validator=process_set_applications_namespace, min_api='2021-07-01')
g.custom_command('application list', 'list_vmss_applications', min_api='2021-07-01')
Expand All @@ -414,7 +416,6 @@ def load_command_table(self, _):
g.custom_command('restart', 'restart_vmss', supports_no_wait=True)
g.custom_command('scale', 'scale_vmss', supports_no_wait=True)
g.custom_show_command('show', 'get_vmss', table_transformer=get_vmss_table_output_transformer(self, False))
g.custom_command('stop', 'stop_vmss', supports_no_wait=True, validator=process_vm_vmss_stop)
g.generic_update_command('update', getter_name='get_vmss_modified_by_aaz', setter_name='update_vmss', supports_no_wait=True, command_type=compute_custom, validator=validate_vmss_update_namespace)
g.custom_command('update-instances', 'update_vmss_instances', supports_no_wait=True)
g.wait_command('wait', getter_name='get_vmss', getter_type=compute_custom)
Expand Down
21 changes: 10 additions & 11 deletions src/azure-cli/azure/cli/command_modules/vm/custom.py
Original file line number Diff line number Diff line change
Expand Up @@ -4509,17 +4509,16 @@ def scale_vmss(cmd, resource_group_name, vm_scale_set_name, new_capacity, no_wai


def stop_vmss(cmd, resource_group_name, vm_scale_set_name, instance_ids=None, no_wait=False, skip_shutdown=False):
client = _compute_client_factory(cmd.cli_ctx)
VirtualMachineScaleSetVMInstanceRequiredIDs = cmd.get_models('VirtualMachineScaleSetVMInstanceRequiredIDs')
if instance_ids is None:
instance_ids = ['*']
instance_ids = VirtualMachineScaleSetVMInstanceRequiredIDs(instance_ids=instance_ids)
if cmd.supported_api_version(min_api='2020-06-01', operation_group='virtual_machine_scale_sets'):
return sdk_no_wait(
no_wait, client.virtual_machine_scale_sets.begin_power_off, resource_group_name, vm_scale_set_name,
vm_instance_i_ds=instance_ids, skip_shutdown=skip_shutdown)
return sdk_no_wait(no_wait, client.virtual_machine_scale_sets.begin_power_off, resource_group_name,
vm_scale_set_name, vm_instance_i_ds=instance_ids)
from .aaz.latest.vmss import Stop as VmssStop
command_args = {
'resource_group': resource_group_name,
'vm_scale_set_name': vm_scale_set_name,
'skip_shutdown': skip_shutdown,
'no_wait': no_wait
}
if instance_ids:
command_args['instance_ids'] = instance_ids
Comment on lines +4519 to +4520
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the default request body for az vmss stop when --instance-ids is omitted: previously the SDK call always sent instanceIds=['*'] (see existing test recordings), but this new implementation omits instance_ids entirely. That will break current recorded tests/playback and may be a behavioral change vs the existing CLI contract. Consider preserving the previous default by setting instance_ids=['*'] when instance_ids is None, or update/re-record the affected vmss stop recordings to match the new payload shape.

Suggested change
if instance_ids:
command_args['instance_ids'] = instance_ids
# Preserve legacy behavior: when --instance-ids is omitted, default to all instances ['*']
if instance_ids is None:
instance_ids = ['*']
command_args['instance_ids'] = instance_ids

Copilot uses AI. Check for mistakes.
return VmssStop(cli_ctx=cmd.cli_ctx)(command_args=command_args)


def update_vmss_instances(cmd, resource_group_name, vm_scale_set_name, instance_ids, no_wait=False):
Expand Down