SessionHostsClient Interface

public interface SessionHostsClient

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

Method Summary

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

Remove a SessionHost.

abstract reactor.core.publisher.Mono<Void> deleteAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

Remove a SessionHost.

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

Remove a SessionHost.

abstract reactor.core.publisher.Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force)

Remove a SessionHost.

abstract SessionHostInner get(String resourceGroupName, String hostPoolName, String sessionHostname)

Get a session host.

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

Get a session host.

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

Get a session host.

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

Get a session host.

abstract PagedIterable<SessionHostInner> list(String resourceGroupName, String hostPoolName)

List sessionHosts.

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

List sessionHosts.

abstract PagedFlux<SessionHostInner> listAsync(String resourceGroupName, String hostPoolName)

List sessionHosts.

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

List sessionHosts.

abstract SessionHostInner update(String resourceGroupName, String hostPoolName, String sessionHostname)

Update a session host.

abstract reactor.core.publisher.Mono<SessionHostInner> updateAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

Update a session host.

abstract Response<SessionHostInner> updateWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force, SessionHostPatch sessionHost, Context context)

Update a session host.

abstract reactor.core.publisher.Mono<Response<SessionHostInner>> updateWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force, SessionHostPatch sessionHost)

Update a session host.

Method Details

delete

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

Remove a SessionHost.

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.

deleteAsync

public abstract Mono<Void> deleteAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

Remove a SessionHost.

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:

A Mono that completes when a successful response is received.

deleteWithResponse

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

Remove a SessionHost.

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.
force - Force flag to force sessionHost deletion even when userSession exists.
context - The context to associate with this operation.

Returns:

deleteWithResponseAsync

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

Remove a SessionHost.

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.
force - Force flag to force sessionHost deletion even when userSession exists.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract SessionHostInner get(String resourceGroupName, String hostPoolName, String sessionHostname)

Get a session host.

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:

a session host.

getAsync

public abstract Mono<SessionHostInner> getAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

Get a session host.

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:

a session host on successful completion of Mono.

getWithResponse

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

Get a session host.

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.
context - The context to associate with this operation.

Returns:

a session host along with Response<T>.

getWithResponseAsync

public abstract Mono<Response<SessionHostInner>> getWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

Get a session host.

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:

a session host along with Response<T> on successful completion of Mono.

list

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

List sessionHosts.

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:

sessionHostList as paginated response with PagedIterable<T>.

list

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

List sessionHosts.

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.
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:

sessionHostList as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux<SessionHostInner> listAsync(String resourceGroupName, String hostPoolName)

List sessionHosts.

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:

sessionHostList as paginated response with PagedFlux<T>.

listAsync

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

List sessionHosts.

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.
pageSize - Number of items per page.
isDescending - Indicates whether the collection is descending.
initialSkip - Initial number of items to skip.

Returns:

sessionHostList as paginated response with PagedFlux<T>.

update

public abstract SessionHostInner update(String resourceGroupName, String hostPoolName, String sessionHostname)

Update a session host.

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:

represents a SessionHost definition.

updateAsync

public abstract Mono<SessionHostInner> updateAsync(String resourceGroupName, String hostPoolName, String sessionHostname)

Update a session host.

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:

represents a SessionHost definition on successful completion of Mono.

updateWithResponse

public abstract Response<SessionHostInner> updateWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force, SessionHostPatch sessionHost, Context context)

Update a session host.

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.
force - Force flag to update assign, unassign or reassign personal desktop.
sessionHost - Object containing SessionHost definitions.
context - The context to associate with this operation.

Returns:

represents a SessionHost definition along with Response<T>.

updateWithResponseAsync

public abstract Mono<Response<SessionHostInner>> updateWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force, SessionHostPatch sessionHost)

Update a session host.

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.
force - Force flag to update assign, unassign or reassign personal desktop.
sessionHost - Object containing SessionHost definitions.

Returns:

represents a SessionHost definition along with Response<T> on successful completion of Mono.

Applies to