HostPools Interface

Package:

com.azure.resourcemanager.desktopvirtualization.models

Maven Artifact:

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

public interface HostPools

Resource collection API of HostPools.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new HostPool resource.
abstract void	delete(String resourceGroupName, String hostPoolName) Remove a host pool.
abstract void	deleteById(String id) Remove a host pool.
abstract Response<Void>	deleteByIdWithResponse(String id, Boolean force, Context context) Remove a host pool.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String hostPoolName, Boolean force, Context context) Remove a host pool.
abstract HostPool	getById(String id) Get a host pool.
abstract Response<HostPool>	getByIdWithResponse(String id, Context context) Get a host pool.
abstract HostPool	getByResourceGroup(String resourceGroupName, String hostPoolName) Get a host pool.
abstract Response<HostPool>	getByResourceGroupWithResponse(String resourceGroupName, String hostPoolName, Context context) Get a host pool.
abstract PagedIterable<HostPool>	list() List hostPools in subscription.
abstract PagedIterable<HostPool>	list(Integer pageSize, Boolean isDescending, Integer initialSkip, Context context) List hostPools in subscription.
abstract PagedIterable<HostPool>	listByResourceGroup(String resourceGroupName) List hostPools.
abstract PagedIterable<HostPool>	listByResourceGroup(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context) List hostPools.
abstract RegistrationTokenList	listRegistrationTokens(String resourceGroupName, String hostPoolName) Operation to list the RegistrationTokens associated with the HostPool.
abstract Response<RegistrationTokenList>	listRegistrationTokensWithResponse(String resourceGroupName, String hostPoolName, Context context) Operation to list the RegistrationTokens associated with the HostPool.
abstract RegistrationInfo	retrieveRegistrationToken(String resourceGroupName, String hostPoolName) Registration token of the host pool.
abstract Response<RegistrationInfo>	retrieveRegistrationTokenWithResponse(String resourceGroupName, String hostPoolName, Context context) Registration token of the host pool.

Method Details

define

public abstract HostPool.DefinitionStages.Blank define(String name)

Begins definition for a new HostPool resource.

Parameters:

name - resource name.

Returns:

the first stage of the new HostPool definition.

delete

public abstract void delete(String resourceGroupName, String hostPoolName)

Remove a host pool.

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.

deleteById

public abstract void deleteById(String id)

Remove a host pool.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Boolean force, Context context)

Remove a host pool.

Parameters:

id - the resource ID.

force - Force flag to delete sessionHost.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

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

Remove a host pool.

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.

force - Force flag to delete sessionHost.

context - The context to associate with this operation.

Returns:

the Response<T>.

getById

public abstract HostPool getById(String id)

Get a host pool.

Parameters:

id - the resource ID.

Returns:

a host pool along with Response<T>.

getByIdWithResponse

public abstract Response<HostPool> getByIdWithResponse(String id, Context context)

Get a host pool.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a host pool along with Response<T>.

getByResourceGroup

public abstract HostPool getByResourceGroup(String resourceGroupName, String hostPoolName)

Get a host pool.

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:

a host pool.

getByResourceGroupWithResponse

public abstract Response<HostPool> getByResourceGroupWithResponse(String resourceGroupName, String hostPoolName, Context context)

Get a host pool.

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.

context - The context to associate with this operation.

Returns:

a host pool along with Response<T>.

list

public abstract PagedIterable<HostPool> list()

List hostPools in subscription.

Returns:

hostPoolList as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<HostPool> list(Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List hostPools in subscription.

Parameters:

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:

hostPoolList as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<HostPool> listByResourceGroup(String resourceGroupName)

List hostPools.

Parameters:

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

Returns:

hostPoolList as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<HostPool> listByResourceGroup(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List hostPools.

Parameters:

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

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:

hostPoolList as paginated response with PagedIterable<T>.

listRegistrationTokens

public abstract RegistrationTokenList listRegistrationTokens(String resourceGroupName, String hostPoolName)

Operation to list the RegistrationTokens associated with the HostPool.

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:

registrationTokenList.

listRegistrationTokensWithResponse

public abstract Response<RegistrationTokenList> listRegistrationTokensWithResponse(String resourceGroupName, String hostPoolName, Context context)

Operation to list the RegistrationTokens associated with the HostPool.

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.

context - The context to associate with this operation.

Returns:

registrationTokenList along with Response<T>.

retrieveRegistrationToken

public abstract RegistrationInfo retrieveRegistrationToken(String resourceGroupName, String hostPoolName)

Registration token of the host pool.

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:

represents a RegistrationInfo definition.

retrieveRegistrationTokenWithResponse

public abstract Response<RegistrationInfo> retrieveRegistrationTokenWithResponse(String resourceGroupName, String hostPoolName, Context context)

Registration token of the host pool.

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.

context - The context to associate with this operation.

Returns:

represents a RegistrationInfo definition along with Response<T>.