Share via

VirtualMachineScaleSetResource.Deallocate Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.5.0
Package:
Azure.ResourceManager.Compute v1.5.0-beta.1
Source:
VirtualMachineScaleSetResource.cs
Source:
VirtualMachineScaleSetResource.cs

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate
  • Operation Id: VirtualMachineScaleSets_Deallocate
  • Default Api Version: 2024-03-01
  • Resource: VirtualMachineScaleSetResource
public virtual Azure.ResourceManager.ArmOperation Deallocate (Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds vmInstanceIds = default, bool? hibernate = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Deallocate : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.Deallocate : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function Deallocate (waitUntil As WaitUntil, Optional vmInstanceIds As VirtualMachineScaleSetVmInstanceIds = Nothing, Optional hibernate As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

vmInstanceIds
VirtualMachineScaleSetVmInstanceIds

A list of virtual machine instance IDs from the VM scale set.

hibernate
Nullable<Boolean>

Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only).

cancellationToken
CancellationToken

The cancellation token to use.

Returns

ArmOperation

Applies to