Package com.azure.resourcemanager.labservices.models

Interface Users

public interface Users
Resource collection API of Users.

  • Method Details

    • listByLab

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

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

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

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

    • getById

      User getById(String id)
      Get a lab user.

      Returns the properties of a lab user.

      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<User> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get a lab user.

      Returns the properties of a lab user.

      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes a user resource.

      Operation to delete a user resource.

      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a user resource.

      Operation to delete a user resource.

      Parameters:
      id - the resource ID.
      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.

    • define

      User.DefinitionStages.Blank define(String name)
      Begins definition for a new User resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new User definition.