Package com.azure.resourcemanager.devtestlabs.fluent

Interface UsersClient

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

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<UserInner> list(String resourceGroupName, String labName)
      List user profiles in a given lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      Returns:
      the response of a list operation 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<UserInner> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List user profiles in a given lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      expand - Specify the $expand query. Example: 'properties($select=identity)'.
      filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
      context - The context to associate with this operation.
      Returns:
      the response of a list operation 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.

    • getWithResponse

      com.azure.core.http.rest.Response<UserInner> getWithResponse(String resourceGroupName, String labName, String name, String expand, com.azure.core.util.Context context)
      Get user profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      expand - Specify the $expand query. Example: 'properties($select=identity)'.
      context - The context to associate with this operation.
      Returns:
      user profile 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.

    • get

      UserInner get(String resourceGroupName, String labName, String name)
      Get user profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      Returns:
      user profile.
      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 name, UserInner user)
      Create or replace an existing user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      user - Profile of a lab user.
      Returns:
      the SyncPoller for polling of profile of a lab user.
      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 name, UserInner user, com.azure.core.util.Context context)
      Create or replace an existing user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      user - Profile of a lab user.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of profile of a lab user.
      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 name, UserInner user)
      Create or replace an existing user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      user - Profile of a lab user.
      Returns:
      profile of a lab user.
      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 name, UserInner user, com.azure.core.util.Context context)
      Create or replace an existing user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      user - Profile of a lab user.
      context - The context to associate with this operation.
      Returns:
      profile of a lab user.
      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 name)
      Delete user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      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 name, com.azure.core.util.Context context)
      Delete user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      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 name)
      Delete user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      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 name, com.azure.core.util.Context context)
      Delete user profile. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      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.

    • updateWithResponse

      com.azure.core.http.rest.Response<UserInner> updateWithResponse(String resourceGroupName, String labName, String name, UserFragment user, com.azure.core.util.Context context)
      Allows modifying tags of user profiles. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      user - Profile of a lab user.
      context - The context to associate with this operation.
      Returns:
      profile of a lab user 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.

    • update

      UserInner update(String resourceGroupName, String labName, String name, UserFragment user)
      Allows modifying tags of user profiles. All other properties will be ignored.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      name - The name of the user profile.
      user - Profile of a lab user.
      Returns:
      profile of a lab user.
      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.