VirtualMachineScaleSetVmResource.PowerOff Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.4.0

Source:

VirtualMachineScaleSetVmResource.cs

Power off (stop) a virtual machine 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}/virtualmachines/{instanceId}/poweroff
• Operation Id: VirtualMachineScaleSetVMs_PowerOff
• Default Api Version: 2023-09-01
• Resource: VirtualMachineScaleSetVmResource

public virtual Azure.ResourceManager.ArmOperation PowerOff (Azure.WaitUntil waitUntil, bool? skipShutdown = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PowerOff : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.PowerOff : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation

Public Overridable Function PowerOff (waitUntil As WaitUntil, Optional skipShutdown 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.

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

ArmOperation