Package com.azure.resourcemanager.desktopvirtualization.models

Interface UserSessions

public interface UserSessions
Resource collection API of UserSessions.

  • Method Details

    • listByHostPool

      com.azure.core.http.rest.PagedIterable<UserSession> listByHostPool(String resourceGroupName, String hostPoolName)
      List userSessions.
      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:
      userSessionList 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.

    • listByHostPool

      com.azure.core.http.rest.PagedIterable<UserSession> listByHostPool(String resourceGroupName, String hostPoolName, String filter, com.azure.core.util.Context context)
      List userSessions.
      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.
      filter - OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.
      context - The context to associate with this operation.
      Returns:
      userSessionList 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.

    • get

      UserSession get(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)
      Get a userSession.
      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.
      userSessionId - The name of the user session within the specified session host.
      Returns:
      a userSession.
      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<UserSession> getWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, com.azure.core.util.Context context)
      Get a userSession.
      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.
      userSessionId - The name of the user session within the specified session host.
      context - The context to associate with this operation.
      Returns:
      a userSession 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, String userSessionId)
      Remove a userSession.
      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.
      userSessionId - The name of the user session within the specified 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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Boolean force, com.azure.core.util.Context context)
      Remove a userSession.
      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.
      userSessionId - The name of the user session within the specified session host.
      force - Force flag to login off userSession.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<UserSession> list(String resourceGroupName, String hostPoolName, String sessionHostname)
      List userSessions.
      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:
      userSessionList 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<UserSession> list(String resourceGroupName, String hostPoolName, String sessionHostname, com.azure.core.util.Context context)
      List userSessions.
      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:
      userSessionList 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.

    • disconnect

      void disconnect(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)
      Disconnect a userSession.
      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.
      userSessionId - The name of the user session within the specified 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.

    • disconnectWithResponse

      com.azure.core.http.rest.Response<Void> disconnectWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, com.azure.core.util.Context context)
      Disconnect a userSession.
      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.
      userSessionId - The name of the user session within the specified session host.
      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.

    • sendMessage

      void sendMessage(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId)
      Send a message to a user.
      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.
      userSessionId - The name of the user session within the specified 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.

    • sendMessageWithResponse

      com.azure.core.http.rest.Response<Void> sendMessageWithResponse(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage, com.azure.core.util.Context context)
      Send a message to a user.
      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.
      userSessionId - The name of the user session within the specified session host.
      sendMessage - Object containing message includes title and message body.
      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.