[Compute] az vmss deallocate: Add --hibernate parameter to support hibernating a VM while deallocating (#27106)

Author: ReaNAiveD

src/azure-cli/azure/cli/command_modules/vm/_params.py

@@ -692,6 +692,9 @@ def load_arguments(self, _):
             for dest in scaleset_name_aliases:
                 c.argument(dest, vmss_name_type, id_part=None)  # due to instance-ids parameter
 
+    with self.argument_context('vmss deallocate', operation_group='virtual_machine_scale_sets') as c:
+        c.argument('hibernate', arg_type=get_three_state_flag(), help='Hibernate a virtual machine from the VM scale set. Available for VMSS with Flexible OrchestrationMode only.', min_api='2023-03-01')
+
     with self.argument_context('vmss reimage') as c:
         c.argument('instance_ids', nargs='+',
                    help='Space-separated list of VM instance ID. If missing, reimage all instances.',

src/azure-cli/azure/cli/command_modules/vm/custom.py

@@ -3655,16 +3655,22 @@ def _build_identities_info_from_system_user_assigned(cmd, mi_system_assigned, mi
     return identity_types, user_assigned_identities
 
 
-def deallocate_vmss(cmd, resource_group_name, vm_scale_set_name, instance_ids=None, no_wait=False):
+def deallocate_vmss(cmd, resource_group_name, vm_scale_set_name, instance_ids=None, no_wait=False, hibernate=None):
     client = _compute_client_factory(cmd.cli_ctx)
-    if instance_ids and len(instance_ids) == 1:
+    # This is a walkaround because the REST service of `VirtualMachineScaleSetVMs#begin_deallocate`
+    # does not accept `hibernate` at present
+    if instance_ids and len(instance_ids) == 1 and hibernate is None:
         return sdk_no_wait(no_wait, client.virtual_machine_scale_set_vms.begin_deallocate,
                            resource_group_name, vm_scale_set_name, instance_ids[0])
 
     VirtualMachineScaleSetVMInstanceIDs = cmd.get_models('VirtualMachineScaleSetVMInstanceIDs')
     vm_instance_i_ds = VirtualMachineScaleSetVMInstanceIDs(instance_ids=instance_ids)
-    return sdk_no_wait(no_wait, client.virtual_machine_scale_sets.begin_deallocate,
-                       resource_group_name, vm_scale_set_name, vm_instance_i_ds)
+    if hibernate is not None:
+        return sdk_no_wait(no_wait, client.virtual_machine_scale_sets.begin_deallocate,
+                           resource_group_name, vm_scale_set_name, vm_instance_i_ds, hibernate=hibernate)
+    else:
+        return sdk_no_wait(no_wait, client.virtual_machine_scale_sets.begin_deallocate,
+                           resource_group_name, vm_scale_set_name, vm_instance_i_ds)
 
 
 def delete_vmss_instances(cmd, resource_group_name, vm_scale_set_name, instance_ids, no_wait=False):