UserSessionsClient Interface

public interface UserSessionsClient

An instance of this class provides access to all the operations defined in UserSessionsClient.

Method Summary

Modifier and Type Method and Description
abstract void delete(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Remove a userSession.

abstract reactor.core.publisher.Mono<Void> deleteAsync(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 reactor.core.publisher.Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Boolean force)

Remove a userSession.

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

Disconnect a userSession.

abstract reactor.core.publisher.Mono<Void> disconnectAsync(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 reactor.core.publisher.Mono<Response<Void>> disconnectWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Disconnect a userSession.

abstract UserSessionInner get(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Get a userSession.

abstract reactor.core.publisher.Mono<UserSessionInner> getAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Get a userSession.

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

Get a userSession.

abstract reactor.core.publisher.Mono<Response<UserSessionInner>> getWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)

Get a userSession.

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

List userSessions.

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

List userSessions.

abstract PagedFlux<UserSessionInner> listAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

List userSessions.

abstract PagedFlux<UserSessionInner> listAsync(String resourceGroupName, String hostPoolName, String sessionHostname, Integer pageSize, Boolean isDescending, Integer initialSkip)

List userSessions.

abstract PagedIterable<UserSessionInner> listByHostPool(String resourceGroupName, String hostPoolName)

List userSessions.

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

List userSessions.

abstract PagedFlux<UserSessionInner> listByHostPoolAsync(String resourceGroupName, String hostPoolName)

List userSessions.

abstract PagedFlux<UserSessionInner> listByHostPoolAsync(String resourceGroupName, String hostPoolName, String filter, Integer pageSize, Boolean isDescending, Integer initialSkip)

List userSessions.

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

Send a message to a user.

abstract reactor.core.publisher.Mono<Void> sendMessageAsync(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.

abstract reactor.core.publisher.Mono<Response<Void>> sendMessageWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage)

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.

deleteAsync

public abstract Mono<Void> deleteAsync(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.

Returns:

A Mono that completes when a successful response is received.

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:

deleteWithResponseAsync

public abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Boolean force)

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.

Returns:

the Response<T> on successful completion of Mono.

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.

disconnectAsync

public abstract Mono<Void> disconnectAsync(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.

Returns:

A Mono that completes when a successful response is received.

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:

disconnectWithResponseAsync

public abstract Mono<Response<Void>> disconnectWithResponseAsync(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.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract UserSessionInner 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.

getAsync

public abstract Mono<UserSessionInner> getAsync(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 on successful completion of Mono.

getWithResponse

public abstract Response<UserSessionInner> 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>.

getWithResponseAsync

public abstract Mono<Response<UserSessionInner>> getWithResponseAsync(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 along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable<UserSessionInner> 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<UserSessionInner> 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>.

listAsync

public abstract PagedFlux<UserSessionInner> listAsync(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 PagedFlux<T>.

listAsync

public abstract PagedFlux<UserSessionInner> listAsync(String resourceGroupName, String hostPoolName, String sessionHostname, Integer pageSize, Boolean isDescending, Integer initialSkip)

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.

Returns:

userSessionList as paginated response with PagedFlux<T>.

listByHostPool

public abstract PagedIterable<UserSessionInner> 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<UserSessionInner> 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>.

listByHostPoolAsync

public abstract PagedFlux<UserSessionInner> listByHostPoolAsync(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 PagedFlux<T>.

listByHostPoolAsync

public abstract PagedFlux<UserSessionInner> listByHostPoolAsync(String resourceGroupName, String hostPoolName, String filter, Integer pageSize, Boolean isDescending, Integer initialSkip)

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.

Returns:

userSessionList as paginated response with PagedFlux<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.

sendMessageAsync

public abstract Mono<Void> sendMessageAsync(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.

Returns:

A Mono that completes when a successful response is received.

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:

sendMessageWithResponseAsync

public abstract Mono<Response<Void>> sendMessageWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage)

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.

Returns:

the Response<T> on successful completion of Mono.

Applies to