DesktopVirtualizationClient.UserSessionsListByHostPool Method

Definition

List userSessions.

public System.Threading.Tasks.Task UserSessionsListByHostPool (string subscriptionId, string resourceGroupName, string hostPoolName, string Filter, int? pageSize, bool? isDescending, int? initialSkip, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20230905.IUserSessionList>,System.Threading.Tasks.Task> onOk, 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.UserSessionsListByHostPool : string * string * string * string * Nullable<int> * Nullable<bool> * Nullable<int> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20230905.IUserSessionList>, 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 UserSessionsListByHostPool (subscriptionId As String, resourceGroupName As String, hostPoolName As String, Filter As String, pageSize As Nullable(Of Integer), isDescending As Nullable(Of Boolean), initialSkip As Nullable(Of Integer), onOk As Func(Of HttpResponseMessage, Task(Of IUserSessionList), 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

Filter
String

OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.

pageSize
Nullable<Int32>

Number of items per page.

isDescending
Nullable<Boolean>

Indicates whether the collection is descending.

initialSkip
Nullable<Int32>

Initial number of items to skip.

onOk
Func<HttpResponseMessage,Task<IUserSessionList>,Task>

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

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

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

Applies to