Package com.azure.resourcemanager.desktopvirtualization.fluent

Interface UserSessionsClient

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

  • Method Details

    • listByHostPoolAsync

      com.azure.core.http.rest.PagedFlux<UserSessionInner> listByHostPoolAsync(String resourceGroupName, String hostPoolName, String filter)
      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.
      Returns:
      userSessionList 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.

    • listByHostPoolAsync

      com.azure.core.http.rest.PagedFlux<UserSessionInner> listByHostPoolAsync(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 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.

    • listByHostPool

      com.azure.core.http.rest.PagedIterable<UserSessionInner> 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<UserSessionInner> 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.

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<UserSessionInner>> getWithResponseAsync(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 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.

    • getAsync

      Mono<UserSessionInner> getAsync(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 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.

    • get

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

    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, Boolean force)
      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.
      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, String sessionHostname, String userSessionId, Boolean force)
      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.
      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, 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.
      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, 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.

    • listAsync

      com.azure.core.http.rest.PagedFlux<UserSessionInner> listAsync(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 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.

    • list

      com.azure.core.http.rest.PagedIterable<UserSessionInner> 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<UserSessionInner> 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.

    • disconnectWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> disconnectWithResponseAsync(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.
      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.

    • disconnectAsync

      Mono<Void> disconnectAsync(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.
      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.

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

    • sendMessageWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> sendMessageWithResponseAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage)
      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.
      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.

    • sendMessageAsync

      Mono<Void> sendMessageAsync(String resourceGroupName, String hostPoolName, String sessionHostname, String userSessionId, SendMessage sendMessage)
      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.
      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.

    • sendMessageAsync

      Mono<Void> sendMessageAsync(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.
      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.

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