Package com.azure.resourcemanager.labservices.fluent

Interface UsersClient

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

  • Method Details

    • listByLab

      com.azure.core.http.rest.PagedIterable<UserInner> listByLab(String resourceGroupName, String labName)
      Get all users for a lab.

      Returns a list of all users for a lab.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      Returns:
      paged list of users 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.

    • listByLab

      com.azure.core.http.rest.PagedIterable<UserInner> listByLab(String resourceGroupName, String labName, String filter, com.azure.core.util.Context context)
      Get all users for a lab.

      Returns a list of all users for a lab.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      filter - The filter to apply to the operation.
      context - The context to associate with this operation.
      Returns:
      paged list of users 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

      UserInner get(String resourceGroupName, String labName, String username)
      Get a lab user.

      Returns the properties of a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      Returns:
      user of a lab that can register for and use virtual machines within the lab.
      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<UserInner> getWithResponse(String resourceGroupName, String labName, String username, com.azure.core.util.Context context)
      Get a lab user.

      Returns the properties of a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      context - The context to associate with this operation.
      Returns:
      user of a lab that can register for and use virtual machines within the lab 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body)
      Create or update a lab user.

      Operation to create or update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      Returns:
      the SyncPoller for polling of user of a lab that can register for and use virtual machines within the lab.
      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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body, com.azure.core.util.Context context)
      Create or update a lab user.

      Operation to create or update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of user of a lab that can register for and use virtual machines within the lab.
      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

      UserInner createOrUpdate(String resourceGroupName, String labName, String username, UserInner body)
      Create or update a lab user.

      Operation to create or update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      Returns:
      user of a lab that can register for and use virtual machines within the lab.
      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

      UserInner createOrUpdate(String resourceGroupName, String labName, String username, UserInner body, com.azure.core.util.Context context)
      Create or update a lab user.

      Operation to create or update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      context - The context to associate with this operation.
      Returns:
      user of a lab that can register for and use virtual machines within the lab.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body)
      Update a lab user.

      Operation to update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      Returns:
      the SyncPoller for polling of user of a lab that can register for and use virtual machines within the lab.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body, com.azure.core.util.Context context)
      Update a lab user.

      Operation to update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of user of a lab that can register for and use virtual machines within the lab.
      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

      UserInner update(String resourceGroupName, String labName, String username, UserUpdate body)
      Update a lab user.

      Operation to update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      Returns:
      user of a lab that can register for and use virtual machines within the lab.
      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

      UserInner update(String resourceGroupName, String labName, String username, UserUpdate body, com.azure.core.util.Context context)
      Update a lab user.

      Operation to update a lab user.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      context - The context to associate with this operation.
      Returns:
      user of a lab that can register for and use virtual machines within the lab.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username)
      Deletes a user resource.

      Operation to delete a user resource.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username, com.azure.core.util.Context context)
      Deletes a user resource.

      Operation to delete a user resource.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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 labName, String username)
      Deletes a user resource.

      Operation to delete a user resource.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      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 labName, String username, com.azure.core.util.Context context)
      Deletes a user resource.

      Operation to delete a user resource.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      context - The context to associate with this operation.
      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.

    • beginInvite

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginInvite(String resourceGroupName, String labName, String username, InviteBody body)
      Invite a user to a lab.

      Operation to invite a user to a lab.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.

    • beginInvite

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginInvite(String resourceGroupName, String labName, String username, InviteBody body, com.azure.core.util.Context context)
      Invite a user to a lab.

      Operation to invite a user to a lab.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.

    • invite

      void invite(String resourceGroupName, String labName, String username, InviteBody body)
      Invite a user to a lab.

      Operation to invite a user to a lab.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      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.

    • invite

      void invite(String resourceGroupName, String labName, String username, InviteBody body, com.azure.core.util.Context context)
      Invite a user to a lab.

      Operation to invite a user to a lab.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
      username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
      body - The request body.
      context - The context to associate with this operation.
      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.