Interface RolesClient
public interface RolesClient
An instance of this class provides access to all the operations defined in RolesClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RoleInner>,
RoleInner> beginCreateOrUpdate
(String deviceName, String name, String resourceGroupName, RoleInner role) Create or update a role.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RoleInner>,
RoleInner> beginCreateOrUpdate
(String deviceName, String name, String resourceGroupName, RoleInner role, com.azure.core.util.Context context) Create or update a role.beginDelete
(String deviceName, String name, String resourceGroupName) Deletes the role on the device.beginDelete
(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context) Deletes the role on the device.createOrUpdate
(String deviceName, String name, String resourceGroupName, RoleInner role) Create or update a role.createOrUpdate
(String deviceName, String name, String resourceGroupName, RoleInner role, com.azure.core.util.Context context) Create or update a role.void
Deletes the role on the device.void
delete
(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context) Deletes the role on the device.Gets a specific role by name.com.azure.core.http.rest.Response<RoleInner>
getWithResponse
(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context) Gets a specific role by name.com.azure.core.http.rest.PagedIterable<RoleInner>
listByDataBoxEdgeDevice
(String deviceName, String resourceGroupName) Lists all the roles configured in a Data Box Edge/Data Box Gateway device.com.azure.core.http.rest.PagedIterable<RoleInner>
listByDataBoxEdgeDevice
(String deviceName, String resourceGroupName, com.azure.core.util.Context context) Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
-
Method Details
-
listByDataBoxEdgeDevice
com.azure.core.http.rest.PagedIterable<RoleInner> listByDataBoxEdgeDevice(String deviceName, String resourceGroupName) Lists all the roles configured in a Data Box Edge/Data Box Gateway device.- Parameters:
deviceName
- The device name.resourceGroupName
- The resource group name.- Returns:
- collection of all the roles on the Data Box Edge 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<RoleInner> listByDataBoxEdgeDevice(String deviceName, String resourceGroupName, com.azure.core.util.Context context) Lists all the roles configured in a Data Box Edge/Data Box Gateway device.- Parameters:
deviceName
- The device name.resourceGroupName
- The resource group name.context
- The context to associate with this operation.- Returns:
- collection of all the roles on the Data Box Edge 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<RoleInner> getWithResponse(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context) Gets a specific role by name.- Parameters:
deviceName
- The device name.name
- The role name.resourceGroupName
- The resource group name.context
- The context to associate with this operation.- Returns:
- a specific role by name 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 a specific role by name.- Parameters:
deviceName
- The device name.name
- The role name.resourceGroupName
- The resource group name.- Returns:
- a specific role by 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RoleInner>,RoleInner> beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, RoleInner role) Create or update a role.- Parameters:
deviceName
- The device name.name
- The role name.resourceGroupName
- The resource group name.role
- The role properties.- Returns:
- the
SyncPoller
for polling of compute role. - 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<RoleInner>,RoleInner> beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, RoleInner role, com.azure.core.util.Context context) Create or update a role.- Parameters:
deviceName
- The device name.name
- The role name.resourceGroupName
- The resource group name.role
- The role properties.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of compute role. - 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
Create or update a role.- Parameters:
deviceName
- The device name.name
- The role name.resourceGroupName
- The resource group name.role
- The role properties.- Returns:
- compute role.
- 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
RoleInner createOrUpdate(String deviceName, String name, String resourceGroupName, RoleInner role, com.azure.core.util.Context context) Create or update a role.- Parameters:
deviceName
- The device name.name
- The role name.resourceGroupName
- The resource group name.role
- The role properties.context
- The context to associate with this operation.- Returns:
- compute role.
- 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 role on the device.- Parameters:
deviceName
- The device name.name
- The role 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 role on the device.- Parameters:
deviceName
- The device name.name
- The role 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
Deletes the role on the device.- Parameters:
deviceName
- The device name.name
- The role 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 role on the device.- Parameters:
deviceName
- The device name.name
- The role 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.
-