Share via


UserSessionCollection Class

Definition

A class representing a collection of UserSessionResource and their operations. Each UserSessionResource in the collection will belong to the same instance of SessionHostResource. To get an UserSessionCollection instance call the GetUserSessions method from an instance of SessionHostResource.

public class UserSessionCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
type UserSessionCollection = class
    inherit ArmCollection
    interface seq<UserSessionResource>
    interface IEnumerable
    interface IAsyncEnumerable<UserSessionResource>
Public Class UserSessionCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of UserSessionResource), IEnumerable(Of UserSessionResource)
Inheritance
UserSessionCollection
Implements

Constructors

UserSessionCollection()

Initializes a new instance of the UserSessionCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
Get(String, CancellationToken)

Get a userSession.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
GetAll(Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)

List userSessions.

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

List userSessions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions
  • Operation Id: UserSessions_List
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
GetAsync(String, CancellationToken)

Get a userSession.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<UserSessionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<UserSessionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to