HostPoolResource.GetUserSessionsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetUserSessionsAsync(String, CancellationToken) |
List userSessions.
|
GetUserSessionsAsync(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) |
List userSessions.
|
GetUserSessionsAsync(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.AsyncPageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource> GetUserSessionsAsync (string filter, System.Threading.CancellationToken cancellationToken);
abstract member GetUserSessionsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
override this.GetUserSessionsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
Public Overridable Function GetUserSessionsAsync (filter As String, cancellationToken As CancellationToken) As AsyncPageable(Of UserSessionResource)
Parameters
- filter
- String
OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of UserSessionResource that may take multiple service requests to iterate over.
Applies to
GetUserSessionsAsync(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.AsyncPageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource> GetUserSessionsAsync (string filter = default, int? pageSize = default, bool? isDescending = default, int? initialSkip = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetUserSessionsAsync : string * Nullable<int> * Nullable<bool> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
override this.GetUserSessionsAsync : string * Nullable<int> * Nullable<bool> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
Public Overridable Function GetUserSessionsAsync (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 AsyncPageable(Of UserSessionResource)
Parameters
- filter
- String
OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of UserSessionResource that may take multiple service requests to iterate over.