AvsPrivateCloudClusterVirtualMachineResource.RestrictMovementAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Avs
Assembly:
Azure.ResourceManager.Avs.dll
Package:
Azure.ResourceManager.Avs v1.3.0
Package:
Azure.ResourceManager.Avs v1.2.0-beta.1
Source:
AvsPrivateCloudClusterVirtualMachineResource.cs
Source:
AvsPrivateCloudClusterVirtualMachineResource.cs

Enable or disable DRS-driven VM movement restriction

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}/restrictMovement
  • Operation Id: VirtualMachines_RestrictMovement
  • Default Api Version: 2023-03-01
  • Resource: AvsPrivateCloudClusterVirtualMachineResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> RestrictMovementAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Avs.Models.AvsPrivateCloudClusterVirtualMachineRestrictMovement restrictMovement, System.Threading.CancellationToken cancellationToken = default);
abstract member RestrictMovementAsync : Azure.WaitUntil * Azure.ResourceManager.Avs.Models.AvsPrivateCloudClusterVirtualMachineRestrictMovement * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.RestrictMovementAsync : Azure.WaitUntil * Azure.ResourceManager.Avs.Models.AvsPrivateCloudClusterVirtualMachineRestrictMovement * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function RestrictMovementAsync (waitUntil As WaitUntil, restrictMovement As AvsPrivateCloudClusterVirtualMachineRestrictMovement, 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.

restrictMovement
AvsPrivateCloudClusterVirtualMachineRestrictMovement

Whether VM DRS-driven movement is restricted (Enabled) or not (Disabled).

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Exceptions

ArgumentNullException

restrictMovement is null.

Applies to