Users Interface

Package:

com.azure.resourcemanager.labservices.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-labservices:1.0.0-beta.4

public interface Users

Resource collection API of Users.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new User resource.
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 void	deleteById(String id) Deletes a user resource.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes a user resource.
abstract User	get(String resourceGroupName, String labName, String username) Get a lab user.
abstract User	getById(String id) Get a lab user.
abstract Response<User>	getByIdWithResponse(String id, Context context) Get a lab user.
abstract Response<User>	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<User>	listByLab(String resourceGroupName, String labName) Get all users for a lab.
abstract PagedIterable<User>	listByLab(String resourceGroupName, String labName, String filter, Context context) Get all users for a lab.

Method Details

define

public abstract User.DefinitionStages.Blank define(String name)

Begins definition for a new User resource.

Parameters:

name - resource name.

Returns:

the first stage of the new User definition.

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.

deleteById

public abstract void deleteById(String id)

Deletes a user resource. Operation to delete a user resource.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a user resource. Operation to delete a user resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

get

public abstract User 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.

getById

public abstract User getById(String id)

Get a lab user. Returns the properties of a lab user.

Parameters:

id - the resource ID.

Returns:

user of a lab that can register for and use virtual machines within the lab along with Response<T>.

getByIdWithResponse

public abstract Response<User> getByIdWithResponse(String id, Context context)

Get a lab user. Returns the properties of a lab user.

Parameters:

id - the resource ID.

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

getWithResponse

public abstract Response<User> 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<User> 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<User> 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>.