UserSessionsImpl | @azure/arm-desktopvirtualization

Class containing UserSessions operations.

Hierarchy

UserSessionsImpl

Implements

UserSessions

Index

Constructors

constructor

Methods

Constructors

constructor

new UserSessionsImpl(client: DesktopVirtualizationAPIClient): UserSessionsImpl

- Defined in operations/userSessions.ts:35
Initialize a new instance of the class UserSessions class.

Parameters
- client: DesktopVirtualizationAPIClient
  
  Reference to the service client
Returns UserSessionsImpl

Methods

delete

delete(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsDeleteOptionalParams): Promise<void>

Implementation of UserSessions.delete
- Defined in operations/userSessions.ts:248
Remove a userSession.

Parameters
- 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
- Optional options: UserSessionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

disconnect

disconnect(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsDisconnectOptionalParams): Promise<void>

Implementation of UserSessions.disconnect
- Defined in operations/userSessions.ts:294
Disconnect a userSession.

Parameters
- 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
- Optional options: UserSessionsDisconnectOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsGetOptionalParams): Promise<UserSessionsGetResponse>

Implementation of UserSessions.get
- Defined in operations/userSessions.ts:221
Get a userSession.

Parameters
- 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
- Optional options: UserSessionsGetOptionalParams
  
  The options parameters.
Returns Promise<UserSessionsGetResponse>

list

list(resourceGroupName: string, hostPoolName: string, sessionHostName: string, options?: UserSessionsListOptionalParams): PagedAsyncIterableIterator<UserSession>

Implementation of UserSessions.list
- Defined in operations/userSessions.ts:123
List userSessions.

Parameters
- 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
- Optional options: UserSessionsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<UserSession>

listByHostPool

listByHostPool(resourceGroupName: string, hostPoolName: string, options?: UserSessionsListByHostPoolOptionalParams): PagedAsyncIterableIterator<UserSession>

Implementation of UserSessions.listByHostPool
- Defined in operations/userSessions.ts:51
List userSessions.

Parameters
- 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
- Optional options: UserSessionsListByHostPoolOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<UserSession>

sendMessage

sendMessage(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsSendMessageOptionalParams): Promise<void>

Implementation of UserSessions.sendMessage
- Defined in operations/userSessions.ts:321
Send a message to a user.

Parameters
- 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
- Optional options: UserSessionsSendMessageOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: DesktopVirtualizationAPIClient

Returns UserSessionsImpl

Methods

delete

Parameters

resourceGroupName: string

hostPoolName: string

sessionHostName: string

userSessionId: string

Optional options: UserSessionsDeleteOptionalParams

Returns Promise<void>

disconnect

Parameters

resourceGroupName: string

hostPoolName: string

sessionHostName: string

userSessionId: string

Optional options: UserSessionsDisconnectOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

hostPoolName: string

sessionHostName: string

userSessionId: string

Optional options: UserSessionsGetOptionalParams

Returns Promise<UserSessionsGetResponse>

list

Parameters

resourceGroupName: string

hostPoolName: string

sessionHostName: string

Optional options: UserSessionsListOptionalParams

Returns PagedAsyncIterableIterator<UserSession>

listByHostPool

Parameters

resourceGroupName: string

hostPoolName: string

Optional options: UserSessionsListByHostPoolOptionalParams

Returns PagedAsyncIterableIterator<UserSession>

sendMessage

Parameters

resourceGroupName: string

hostPoolName: string

sessionHostName: string

userSessionId: string

Optional options: UserSessionsSendMessageOptionalParams

Returns Promise<void>