HostPoolResource.GetUserSessions Method

Definition

Namespace:

Azure.ResourceManager.DesktopVirtualization

Assembly:

Azure.ResourceManager.DesktopVirtualization.dll

Package:

Azure.ResourceManager.DesktopVirtualization v1.3.0

Overloads

GetUserSessions(String, CancellationToken)	List userSessions. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions Operation Id: UserSessions_ListByHostPool
GetUserSessions(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)	List userSessions. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions Operation Id: UserSessions_ListByHostPool Default Api Version: 2024-04-03 Resource: UserSessionResource

GetUserSessions(String, CancellationToken)

Source:

HostPoolResource.cs

List userSessions.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
• Operation Id: UserSessions_ListByHostPool

public virtual Azure.Pageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource> GetUserSessions (string filter, System.Threading.CancellationToken cancellationToken);

abstract member GetUserSessions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
override this.GetUserSessions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>

Public Overridable Function GetUserSessions (filter As String, cancellationToken As CancellationToken) As Pageable(Of UserSessionResource)

Parameters

filter

String

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

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<UserSessionResource>

A collection of UserSessionResource that may take multiple service requests to iterate over.

GetUserSessions(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)

Source:

HostPoolResource.cs

List userSessions.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
• Operation Id: UserSessions_ListByHostPool
• Default Api Version: 2024-04-03
• Resource: UserSessionResource

public virtual Azure.Pageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource> GetUserSessions (string filter = default, int? pageSize = default, bool? isDescending = default, int? initialSkip = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetUserSessions : string * Nullable<int> * Nullable<bool> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
override this.GetUserSessions : string * Nullable<int> * Nullable<bool> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>

Public Overridable Function GetUserSessions (Optional filter As String = Nothing, Optional pageSize As Nullable(Of Integer) = Nothing, Optional isDescending As Nullable(Of Boolean) = Nothing, Optional initialSkip As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of UserSessionResource)

Parameters

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.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<UserSessionResource>

A collection of UserSessionResource that may take multiple service requests to iterate over.