UserSessions Interface

Package:

com.azure.resourcemanager.desktopvirtualization.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-desktopvirtualization:1.2.0

public interface UserSessions

Resource collection API of UserSessions.

Method Summary

Modifier and Type	Method and Description
abstract void	delete(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId) Remove a userSession.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Boolean force, Context context) Remove a userSession.
abstract void	disconnect(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId) Disconnect a userSession.
abstract Response<Void>	disconnectWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Context context) Disconnect a userSession.
abstract UserSession	get(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId) Get a userSession.
abstract Response<UserSession>	getWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Context context) Get a userSession.
abstract PagedIterable<UserSession>	list(String resourceGroupName, String hostPoolName, String sessionHostname) List userSessions.
abstract PagedIterable<UserSession>	list(String resourceGroupName, String hostPoolName, String sessionHostname, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context) List userSessions.
abstract PagedIterable<UserSession>	listByHostPool(String resourceGroupName, String hostPoolName) List userSessions.
abstract PagedIterable<UserSession>	listByHostPool(String resourceGroupName, String hostPoolName, String filter, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context) List userSessions.
abstract void	sendMessage(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId) Send a message to a user.
abstract Response<Void>	sendMessageWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage, Context context) Send a message to a user.

Method Details

delete

public abstract void delete(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Remove a userSession.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Boolean force, Context context)

Remove a userSession.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

force - Force flag to login off userSession.

context - The context to associate with this operation.

Returns:

the Response<T>.

disconnect

public abstract void disconnect(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Disconnect a userSession.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

disconnectWithResponse

public abstract Response<Void> disconnectWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Context context)

Disconnect a userSession.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract UserSession get(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Get a userSession.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

Returns:

a userSession.

getWithResponse

public abstract Response<UserSession> getWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Context context)

Get a userSession.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

context - The context to associate with this operation.

Returns:

a userSession along with Response<T>.

list

public abstract PagedIterable<UserSession> list(String resourceGroupName, String hostPoolName, String sessionHostname)

List userSessions.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

Returns:

userSessionList as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<UserSession> list(String resourceGroupName, String hostPoolName, String sessionHostname, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List userSessions.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

pageSize - Number of items per page.

isDescending - Indicates whether the collection is descending.

initialSkip - Initial number of items to skip.

context - The context to associate with this operation.

Returns:

userSessionList as paginated response with PagedIterable<T>.

listByHostPool

public abstract PagedIterable<UserSession> listByHostPool(String resourceGroupName, String hostPoolName)

List userSessions.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

Returns:

userSessionList as paginated response with PagedIterable<T>.

listByHostPool

public abstract PagedIterable<UserSession> listByHostPool(String resourceGroupName, String hostPoolName, String filter, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List userSessions.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

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

pageSize - Number of items per page.

isDescending - Indicates whether the collection is descending.

initialSkip - Initial number of items to skip.

context - The context to associate with this operation.

Returns:

userSessionList as paginated response with PagedIterable<T>.

sendMessage

public abstract void sendMessage(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Send a message to a user.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

sendMessageWithResponse

public abstract Response<Void> sendMessageWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage, Context context)

Send a message to a user.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

hostPoolName - The name of the host pool within the specified resource group.

sessionHostname - The name of the session host within the specified host pool.

userSessionId - The name of the user session within the specified session host.

sendMessage - Object containing message includes title and message body.

context - The context to associate with this operation.

Returns:

the Response<T>.