Delen via

VirtualMachineScaleSetResource.PowerOff Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.8.0
Package:
Azure.ResourceManager.Compute v1.9.0-beta.1
Source:
VirtualMachineScaleSetResource.cs
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. Additionally, this operation is not allowed on virtual machines in a VM scale set that are being deallocated or have already been deallocated.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff
  • Operation Id: VirtualMachineScaleSets_PowerOff
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
public virtual Azure.ResourceManager.ArmOperation PowerOff(Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds vmInstanceIds = default, bool? skipShutdown = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PowerOff : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.PowerOff : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function PowerOff (waitUntil As WaitUntil, Optional vmInstanceIds As VirtualMachineScaleSetVmInstanceIds = Nothing, 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.

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

ArmOperation

Applies to