SessionHosts Interface

Package:

com.azure.resourcemanager.desktopvirtualization.models

Maven Artifact:

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

public interface SessionHosts

Resource collection API of SessionHosts.

Method Summary

Modifier and Type	Method and Description
abstract void	delete(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 SessionHost	get(String resourceGroupName, String hostPoolName, String sessionHostname) Get a session host.
abstract Response<SessionHost>	getWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, Context context) Get a session host.
abstract PagedIterable<SessionHost>	list(String resourceGroupName, String hostPoolName) List sessionHosts.
abstract PagedIterable<SessionHost>	list(String resourceGroupName, String hostPoolName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context) List sessionHosts.
abstract SessionHost	update(String resourceGroupName, String hostPoolName, String sessionHostname) Update a session host.
abstract Response<SessionHost>	updateWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force, SessionHostPatch sessionHost, Context context) 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.

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:

the Response<T>.

get

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

getWithResponse

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

list

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

update

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

updateWithResponse

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