다음을 통해 공유

VirtualMachineScaleSetResource.DeleteInstancesAsync Method

  • Reference

Definition

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

Deletes virtual machines in a VM scale set.

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

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

forceDeletion
Nullable<Boolean>

Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview).

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Exceptions

ArgumentNullException

vmInstanceIds is null.

Applies to