Package com.azure.resourcemanager.desktopvirtualization.fluent

Interface HostPoolsClient

public interface HostPoolsClient
An instance of this class provides access to all the operations defined in HostPoolsClient.

  • Method Details

    • getByResourceGroupWithResponseAsync

      Mono<com.azure.core.http.rest.Response<HostPoolInner>> getByResourceGroupWithResponseAsync(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 along with Response on successful completion of Mono.
      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.

    • getByResourceGroupAsync

      Mono<HostPoolInner> getByResourceGroupAsync(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 on successful completion of Mono.
      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.

    • getByResourceGroup

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

    • createOrUpdateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<HostPoolInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)
      Create or update 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.
      hostPool - Object containing HostPool definitions.
      Returns:
      represents a HostPool definition along with Response on successful completion of Mono.
      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.

    • createOrUpdateAsync

      Mono<HostPoolInner> createOrUpdateAsync(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)
      Create or update 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.
      hostPool - Object containing HostPool definitions.
      Returns:
      represents a HostPool definition on successful completion of Mono.
      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.

    • createOrUpdate

      HostPoolInner createOrUpdate(String resourceGroupName, String hostPoolName, HostPoolInner hostPool)
      Create or update 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.
      hostPool - Object containing HostPool definitions.
      Returns:
      represents a HostPool 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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<HostPoolInner> createOrUpdateWithResponse(String resourceGroupName, String hostPoolName, HostPoolInner hostPool, com.azure.core.util.Context context)
      Create or update 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.
      hostPool - Object containing HostPool definitions.
      context - The context to associate with this operation.
      Returns:
      represents a HostPool 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.

    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, Boolean force)
      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.
      Returns:
      the Response on successful completion of Mono.
      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.

    • deleteAsync

      Mono<Void> deleteAsync(String resourceGroupName, String hostPoolName, Boolean force)
      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.
      Returns:
      A Mono that completes when a successful response is received.
      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.

    • deleteAsync

      Mono<Void> deleteAsync(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.
      Returns:
      A Mono that completes when a successful response is received.
      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.

    • updateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<HostPoolInner>> updateWithResponseAsync(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool)
      Update 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.
      hostPool - Object containing HostPool definitions.
      Returns:
      represents a HostPool definition along with Response on successful completion of Mono.
      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.

    • updateAsync

      Mono<HostPoolInner> updateAsync(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool)
      Update 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.
      hostPool - Object containing HostPool definitions.
      Returns:
      represents a HostPool definition on successful completion of Mono.
      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.

    • updateAsync

      Mono<HostPoolInner> updateAsync(String resourceGroupName, String hostPoolName)
      Update 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:
      represents a HostPool definition on successful completion of Mono.
      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.

    • update

      HostPoolInner update(String resourceGroupName, String hostPoolName)
      Update 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:
      represents a HostPool 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.

    • updateWithResponse

      com.azure.core.http.rest.Response<HostPoolInner> updateWithResponse(String resourceGroupName, String hostPoolName, HostPoolPatch hostPool, com.azure.core.util.Context context)
      Update 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.
      hostPool - Object containing HostPool definitions.
      context - The context to associate with this operation.
      Returns:
      represents a HostPool 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.

    • listByResourceGroupAsync

      com.azure.core.http.rest.PagedFlux<HostPoolInner> listByResourceGroupAsync(String resourceGroupName)
      List hostPools.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      hostPoolList as paginated response with PagedFlux.
      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<HostPoolInner> 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<HostPoolInner> 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.

    • listAsync

      com.azure.core.http.rest.PagedFlux<HostPoolInner> listAsync()
      List hostPools in subscription.
      Returns:
      hostPoolList as paginated response with PagedFlux.
      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<HostPoolInner> 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<HostPoolInner> 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.

    • retrieveRegistrationTokenWithResponseAsync

      Mono<com.azure.core.http.rest.Response<RegistrationInfoInner>> retrieveRegistrationTokenWithResponseAsync(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 along with Response on successful completion of Mono.
      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.

    • retrieveRegistrationTokenAsync

      Mono<RegistrationInfoInner> retrieveRegistrationTokenAsync(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 on successful completion of Mono.
      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

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