UserSessions interface

Package:

@azure/arm-desktopvirtualization

Interface representing a UserSessions.

Methods

delete(string, string, string, string, UserSessionsDeleteOptionalParams)	Remove a userSession.
disconnect(string, string, string, string, UserSessionsDisconnectOptionalParams)	Disconnect a userSession.
get(string, string, string, string, UserSessionsGetOptionalParams)	Get a userSession.
list(string, string, string, UserSessionsListOptionalParams)	List userSessions.
listByHostPool(string, string, UserSessionsListByHostPoolOptionalParams)	List userSessions.
sendMessage(string, string, string, string, UserSessionsSendMessageOptionalParams)	Send a message to a user.

Method Details

delete(string, string, string, string, UserSessionsDeleteOptionalParams)

Remove a userSession.

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

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

options

UserSessionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

disconnect(string, string, string, string, UserSessionsDisconnectOptionalParams)

Disconnect a userSession.

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

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

options

UserSessionsDisconnectOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, UserSessionsGetOptionalParams)

Get a userSession.

function get(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsGetOptionalParams): Promise<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

options

UserSessionsGetOptionalParams

The options parameters.

Returns

Promise<UserSession>

list(string, string, string, UserSessionsListOptionalParams)

List userSessions.

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

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

options

UserSessionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

listByHostPool(string, string, UserSessionsListByHostPoolOptionalParams)

List userSessions.

function listByHostPool(resourceGroupName: string, hostPoolName: string, options?: UserSessionsListByHostPoolOptionalParams): PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

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

options

UserSessionsListByHostPoolOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

sendMessage(string, string, string, string, UserSessionsSendMessageOptionalParams)

Send a message to a user.

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

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

options

UserSessionsSendMessageOptionalParams

The options parameters.

Returns

Promise<void>