Package com.azure.resourcemanager.desktopvirtualization.models

Interface HostPools

public interface HostPools
Resource collection API of HostPools.

  • Method Details

    • getByResourceGroup

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<HostPool> getByResourceGroupWithResponse(String resourceGroupName, String hostPoolName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String hostPoolName, Boolean force, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<HostPool> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      List hostPools.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      hostPoolList as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<HostPool> list()
      List hostPools in subscription.
      Returns:
      hostPoolList as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<HostPool> list(com.azure.core.util.Context context)
      List hostPools in subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      hostPoolList as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • retrieveRegistrationToken

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • retrieveRegistrationTokenWithResponse

      com.azure.core.http.rest.Response<RegistrationInfo> retrieveRegistrationTokenWithResponse(String resourceGroupName, String hostPoolName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      HostPool getById(String id)
      Get a host pool.
      Parameters:
      id - the resource ID.
      Returns:
      a host pool along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<HostPool> getByIdWithResponse(String id, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Remove a host pool.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, Boolean force, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      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.