Share via

DesktopVirtualizationClient.UserSessionsDelete Method

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization
Assembly:
Az.DesktopVirtualization.private.dll

Remove a userSession.

public System.Threading.Tasks.Task UserSessionsDelete (string subscriptionId, string resourceGroupName, string hostPoolName, string sessionHostName, string userSessionId, bool? force, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task> onOk, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task> onNoContent, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20230905.ICloudError>,System.Threading.Tasks.Task> onDefault, Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.ISendAsync sender);
member this.UserSessionsDelete : string * string * string * string * string * Nullable<bool> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20230905.ICloudError>, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.ISendAsync -> System.Threading.Tasks.Task
Public Function UserSessionsDelete (subscriptionId As String, resourceGroupName As String, hostPoolName As String, sessionHostName As String, userSessionId As String, force As Nullable(Of Boolean), onOk As Func(Of HttpResponseMessage, Task), onNoContent As Func(Of HttpResponseMessage, Task), onDefault As Func(Of HttpResponseMessage, Task(Of ICloudError), Task), eventListener As IEventListener, sender As ISendAsync) As Task

Parameters

subscriptionId
String

The ID of the target subscription.

resourceGroupName
String

The name of the resource group. The name is case insensitive.

hostPoolName
String

The name of the host pool within the specified resource group

sessionHostName
String

The name of the session host within the specified host pool

userSessionId
String

The name of the user session within the specified session host

force
Nullable<Boolean>

Force flag to login off userSession.

onOk
Func<HttpResponseMessage,Task>

a delegate that is called when the remote service returns 200 (OK).

onNoContent
Func<HttpResponseMessage,Task>

a delegate that is called when the remote service returns 204 (NoContent).

onDefault
Func<HttpResponseMessage,Task<ICloudError>,Task>

a delegate that is called when the remote service returns default (any response code not handled elsewhere).

eventListener
IEventListener

an IEventListener instance that will receive events.

sender
ISendAsync

an instance of an Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.ISendAsync pipeline to use to make the request.

Returns

Task

A Task that will be complete when handling of the response is completed.

Applies to