Package com.azure.resourcemanager.labservices.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 resourceGroupName, String labName, String username, UserInner body)	Operation to create or update a lab user.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner>	beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body, com.azure.core.util.Context context)	Operation to create or update a lab user.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String labName, String username)	Operation to delete a user resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String labName, String username, com.azure.core.util.Context context)	Operation to delete a user resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginInvite(String resourceGroupName, String labName, String username, InviteBody body)	Operation to invite a user to a lab.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginInvite(String resourceGroupName, String labName, String username, InviteBody body, com.azure.core.util.Context context)	Operation to invite a user to a lab.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner>	beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body)	Operation to update a lab user.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner>	beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body, com.azure.core.util.Context context)	Operation to update a lab user.
UserInner	createOrUpdate(String resourceGroupName, String labName, String username, UserInner body)	Operation to create or update a lab user.
UserInner	createOrUpdate(String resourceGroupName, String labName, String username, UserInner body, com.azure.core.util.Context context)	Operation to create or update a lab user.
void	delete(String resourceGroupName, String labName, String username)	Operation to delete a user resource.
void	delete(String resourceGroupName, String labName, String username, com.azure.core.util.Context context)	Operation to delete a user resource.
UserInner	get(String resourceGroupName, String labName, String username)	Returns the properties of a lab user.
com.azure.core.http.rest.Response<UserInner>	getWithResponse(String resourceGroupName, String labName, String username, com.azure.core.util.Context context)	Returns the properties of a lab user.
void	invite(String resourceGroupName, String labName, String username, InviteBody body)	Operation to invite a user to a lab.
void	invite(String resourceGroupName, String labName, String username, InviteBody body, com.azure.core.util.Context context)	Operation to invite a user to a lab.
com.azure.core.http.rest.PagedIterable<UserInner>	listByLab(String resourceGroupName, String labName)	Returns a list of all users for a lab.
com.azure.core.http.rest.PagedIterable<UserInner>	listByLab(String resourceGroupName, String labName, String filter, com.azure.core.util.Context context)	Returns a list of all users for a lab.
UserInner	update(String resourceGroupName, String labName, String username, UserUpdate body)	Operation to update a lab user.
UserInner	update(String resourceGroupName, String labName, String username, UserUpdate body, com.azure.core.util.Context context)	Operation to update a lab user.

Method Detail

listByLab

com.azure.core.http.rest.PagedIterable<UserInner> listByLab(String resourceGroupName,
                                                            String labName)

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 account. Used in resource URIs.

Returns:

paged list of users.

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<UserInner> listByLab(String resourceGroupName,
                                                            String labName,
                                                            String filter,
                                                            com.azure.core.util.Context context)

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

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 username)

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 account. 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<UserInner> getWithResponse(String resourceGroupName,
                                                             String labName,
                                                             String username,
                                                             com.azure.core.util.Context context)

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

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                    String labName,
                                                                                                                                    String username,
                                                                                                                                    UserInner body)

Operation to create or update 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 account. 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.

Returns:

user of a lab that can register for and use virtual machines within the lab along with Response on successful completion of Mono.

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 username,
                                                                                                                                    UserInner body,
                                                                                                                                    com.azure.core.util.Context context)

Operation to create or update 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 account. 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.

Returns:

user of a lab that can register for and use virtual machines within the lab along with Response on successful completion of Mono.

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 username,
                         UserInner body)

Operation to create or update 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 account. 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.

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.

createOrUpdate

UserInner createOrUpdate(String resourceGroupName,
                         String labName,
                         String username,
                         UserInner body,
                         com.azure.core.util.Context context)

Operation to create or update 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 account. 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.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName,
                                                                                                                            String labName,
                                                                                                                            String username,
                                                                                                                            UserUpdate body)

Operation to update 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 account. 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.

Returns:

user of a lab that can register for and use virtual machines within the lab along with Response on successful completion of Mono.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName,
                                                                                                                            String labName,
                                                                                                                            String username,
                                                                                                                            UserUpdate body,
                                                                                                                            com.azure.core.util.Context context)

Operation to update 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 account. 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.

Returns:

user of a lab that can register for and use virtual machines within the lab along with Response on successful completion of Mono.

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 username,
                 UserUpdate body)

Operation to update 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 account. 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.

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.

update

UserInner update(String resourceGroupName,
                 String labName,
                 String username,
                 UserUpdate body,
                 com.azure.core.util.Context context)

Operation to update 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 account. 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.

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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String labName,
                                                                                                                  String username)

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 account. Used in resource URIs.

username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

Returns:

the Response on successful completion of Mono.

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 username,
                                                                                                                  com.azure.core.util.Context context)

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 account. 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:

the Response on successful completion of Mono.

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)

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 account. 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)

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

beginInvite

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginInvite(String resourceGroupName,
                                                                                                                  String labName,
                                                                                                                  String username,
                                                                                                                  InviteBody body)

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

Returns:

the Response on successful completion of Mono.

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.

beginInvite

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginInvite(String resourceGroupName,
                                                                                                                  String labName,
                                                                                                                  String username,
                                                                                                                  InviteBody body,
                                                                                                                  com.azure.core.util.Context context)

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

Returns:

the Response on successful completion of Mono.

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)

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 account. 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)

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