Share via


UsersClient Interface

public interface UsersClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body)

Create or update a lab user.

abstract SyncPoller<PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body, Context context)

Create or update a lab user.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username)

Deletes a user resource.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username, Context context)

Deletes a user resource.

abstract SyncPoller<PollResult<Void>,Void> beginInvite(String resourceGroupName, String labName, String username, InviteBody body)

Invite a user to a lab.

abstract SyncPoller<PollResult<Void>,Void> beginInvite(String resourceGroupName, String labName, String username, InviteBody body, Context context)

Invite a user to a lab.

abstract SyncPoller<PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body)

Update a lab user.

abstract SyncPoller<PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body, Context context)

Update a lab user.

abstract UserInner createOrUpdate(String resourceGroupName, String labName, String username, UserInner body)

Create or update a lab user.

abstract UserInner createOrUpdate(String resourceGroupName, String labName, String username, UserInner body, Context context)

Create or update a lab user.

abstract void delete(String resourceGroupName, String labName, String username)

Deletes a user resource.

abstract void delete(String resourceGroupName, String labName, String username, Context context)

Deletes a user resource.

abstract UserInner get(String resourceGroupName, String labName, String username)

Get a lab user.

abstract Response<UserInner> getWithResponse(String resourceGroupName, String labName, String username, Context context)

Get a lab user.

abstract void invite(String resourceGroupName, String labName, String username, InviteBody body)

Invite a user to a lab.

abstract void invite(String resourceGroupName, String labName, String username, InviteBody body, Context context)

Invite a user to a lab.

abstract PagedIterable<UserInner> listByLab(String resourceGroupName, String labName)

Get all users for a lab.

abstract PagedIterable<UserInner> listByLab(String resourceGroupName, String labName, String filter, Context context)

Get all users for a lab.

abstract UserInner update(String resourceGroupName, String labName, String username, UserUpdate body)

Update a lab user.

abstract UserInner update(String resourceGroupName, String labName, String username, UserUpdate body, Context context)

Update a lab user.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body)

Create or update a lab user. 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 plan. 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 SyncPoller<T,U> for polling of user of a lab that can register for and use virtual machines within the lab.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, UserInner body, Context context)

Create or update a lab user. 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 plan. 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 SyncPoller<T,U> for polling of user of a lab that can register for and use virtual machines within the lab.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username)

Deletes a user resource. 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 plan. Used in resource URIs.
username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String username, Context context)

Deletes a user resource. 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 plan. 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 SyncPoller<T,U> for polling of long-running operation.

beginInvite

public abstract SyncPoller<PollResult<Void>,Void> beginInvite(String resourceGroupName, String labName, String username, InviteBody body)

Invite a user to a lab. 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 plan. 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 SyncPoller<T,U> for polling of long-running operation.

beginInvite

public abstract SyncPoller<PollResult<Void>,Void> beginInvite(String resourceGroupName, String labName, String username, InviteBody body, Context context)

Invite a user to a lab. 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 plan. 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 SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body)

Update a lab user. 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 plan. 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 SyncPoller<T,U> for polling of user of a lab that can register for and use virtual machines within the lab.

beginUpdate

public abstract SyncPoller<PollResult<UserInner>,UserInner> beginUpdate(String resourceGroupName, String labName, String username, UserUpdate body, Context context)

Update a lab user. 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 plan. 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 SyncPoller<T,U> for polling of user of a lab that can register for and use virtual machines within the lab.

createOrUpdate

public abstract UserInner createOrUpdate(String resourceGroupName, String labName, String username, UserInner body)

Create or update a lab user. 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 plan. 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.

createOrUpdate

public abstract UserInner createOrUpdate(String resourceGroupName, String labName, String username, UserInner body, Context context)

Create or update a lab user. 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 plan. 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.

delete

public abstract void delete(String resourceGroupName, String labName, String username)

Deletes a user resource. 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 plan. Used in resource URIs.
username - The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

delete

public abstract void delete(String resourceGroupName, String labName, String username, Context context)

Deletes a user resource. 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 plan. 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.

get

public abstract UserInner get(String resourceGroupName, String labName, String username)

Get a lab user. 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 plan. 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.

getWithResponse

public abstract Response<UserInner> getWithResponse(String resourceGroupName, String labName, String username, Context context)

Get a lab user. 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 plan. 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<T>.

invite

public abstract void invite(String resourceGroupName, String labName, String username, InviteBody body)

Invite a user to a lab. 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 plan. 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.

invite

public abstract void invite(String resourceGroupName, String labName, String username, InviteBody body, Context context)

Invite a user to a lab. 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 plan. 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.

listByLab

public abstract PagedIterable<UserInner> listByLab(String resourceGroupName, String labName)

Get all users for a lab. 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 plan. Used in resource URIs.

Returns:

paged list of users as paginated response with PagedIterable<T>.

listByLab

public abstract PagedIterable<UserInner> listByLab(String resourceGroupName, String labName, String filter, Context context)

Get all users for a lab. 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 plan. 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 as paginated response with PagedIterable<T>.

update

public abstract UserInner update(String resourceGroupName, String labName, String username, UserUpdate body)

Update a lab user. 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 plan. 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.

update

public abstract UserInner update(String resourceGroupName, String labName, String username, UserUpdate body, Context context)

Update a lab user. 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 plan. 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.

Applies to