Package com.azure.resourcemanager.desktopvirtualization.models

Interface SessionHosts

public interface SessionHosts
Resource collection API of SessionHosts.

  • Method Details

    • get

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

    • getWithResponse

      com.azure.core.http.rest.Response<SessionHost> getWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, com.azure.core.util.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.
      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, 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.
      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, String sessionHostname, Boolean force, com.azure.core.util.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.
      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

      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.
      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<SessionHost> updateWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, Boolean force, SessionHostPatch sessionHost, com.azure.core.util.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.
      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<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.
      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<SessionHost> list(String resourceGroupName, String hostPoolName, com.azure.core.util.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.
      context - The context to associate with this operation.
      Returns:
      sessionHostList 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.