SessionHostResource.DeleteAsync Method

Definition

Remove a SessionHost.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
  • Operation Id: SessionHosts_Delete
  • Default Api Version: 2024-04-03
  • Resource: SessionHostResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeleteAsync (Azure.WaitUntil waitUntil, bool? force = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.DeleteAsync : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function DeleteAsync (waitUntil As WaitUntil, Optional force 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.

force
Nullable<Boolean>

Force flag to force sessionHost deletion even when userSession exists.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to