VirtualMachineScaleSetResource.PowerOffAsync Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.4.0

Source:

VirtualMachineScaleSetResource.cs

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.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff
• Operation Id: VirtualMachineScaleSets_PowerOff
• Default Api Version: 2023-09-01
• Resource: VirtualMachineScaleSetResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> PowerOffAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds vmInstanceIds = default, bool? skipShutdown = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PowerOffAsync : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.PowerOffAsync : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>

Public Overridable Function PowerOffAsync (waitUntil As WaitUntil, Optional vmInstanceIds As VirtualMachineScaleSetVmInstanceIds = Nothing, Optional skipShutdown As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.

skipShutdown

Nullable<Boolean>

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.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>