Interface Users
public interface Users
Resource collection API of Users.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new User resource.void
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.void
deleteById
(String id) Deletes the user on a databox edge/gateway device.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes the user on a databox edge/gateway device.Gets the properties of the specified user.Gets the properties of the specified user.com.azure.core.http.rest.Response<User>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets the properties of the specified user.com.azure.core.http.rest.Response<User>
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<User>
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<User>
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<User> 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<User> 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<User> 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
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.
-
delete
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.
-
getById
Gets the properties of the specified user.- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<User> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets the properties of the specified user.- Parameters:
id
- the resource ID.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.
-
deleteById
Deletes the user on a databox edge/gateway device.- 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
Deletes the user on a databox edge/gateway device.- 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
Begins definition for a new User resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new User definition.
-