Package com.azure.resourcemanager.databoxedge.fluent

Interface UsersClient

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner>
    beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, UserInner user)
    Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner>
    beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, UserInner user, com.azure.core.util.Context context)
    Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginDelete(String deviceName, String name, String resourceGroupName)
    Deletes the user on a databox edge/gateway device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginDelete(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Deletes the user on a databox edge/gateway device.
    UserInner
    createOrUpdate(String deviceName, String name, String resourceGroupName, UserInner user)
    Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
    UserInner
    createOrUpdate(String deviceName, String name, String resourceGroupName, UserInner user, com.azure.core.util.Context context)
    Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
    void
    delete(String deviceName, String name, String resourceGroupName)
    Deletes the user on a databox edge/gateway device.
    void
    delete(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Deletes the user on a databox edge/gateway device.
    UserInner
    get(String deviceName, String name, String resourceGroupName)
    Gets the properties of the specified user.
    com.azure.core.http.rest.Response<UserInner>
    getWithResponse(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Gets the properties of the specified user.
    com.azure.core.http.rest.PagedIterable<UserInner>
    listByDataBoxEdgeDevice(String deviceName, String resourceGroupName)
    Gets all the users registered on a Data Box Edge/Data Box Gateway device.
    com.azure.core.http.rest.PagedIterable<UserInner>
    listByDataBoxEdgeDevice(String deviceName, String resourceGroupName, String filter, com.azure.core.util.Context context)
    Gets all the users registered on a Data Box Edge/Data Box Gateway device.

  • Method Details

    • listByDataBoxEdgeDevice

      com.azure.core.http.rest.PagedIterable<UserInner> listByDataBoxEdgeDevice(String deviceName, String resourceGroupName)
      Gets all the users registered on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      Returns:
      all the users registered on a Data Box Edge/Data Box Gateway device 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.

    • listByDataBoxEdgeDevice

      com.azure.core.http.rest.PagedIterable<UserInner> listByDataBoxEdgeDevice(String deviceName, String resourceGroupName, String filter, com.azure.core.util.Context context)
      Gets all the users registered on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      filter - Specify $filter='UserType eq <type>' to filter on user type property.
      context - The context to associate with this operation.
      Returns:
      all the users registered on a Data Box Edge/Data Box Gateway device 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 deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Gets the properties of the specified user.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      the properties of the specified 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.

    • get

      UserInner get(String deviceName, String name, String resourceGroupName)
      Gets the properties of the specified user.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      Returns:
      the properties of the specified 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 deviceName, String name, String resourceGroupName, UserInner user)
      Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      user - The user details.
      Returns:
      the SyncPoller for polling of represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
      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 deviceName, String name, String resourceGroupName, UserInner user, com.azure.core.util.Context context)
      Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      user - The user details.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
      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 deviceName, String name, String resourceGroupName, UserInner user)
      Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      user - The user details.
      Returns:
      represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
      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 deviceName, String name, String resourceGroupName, UserInner user, com.azure.core.util.Context context)
      Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      user - The user details.
      context - The context to associate with this operation.
      Returns:
      represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
      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 deviceName, String name, String resourceGroupName)
      Deletes the user on a databox edge/gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      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 deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Deletes the user on a databox edge/gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      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 deviceName, String name, String resourceGroupName)
      Deletes the user on a databox edge/gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      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 deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Deletes the user on a databox edge/gateway device.
      Parameters:
      deviceName - The device name.
      name - The user name.
      resourceGroupName - The resource group name.
      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.