Users Interface

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

Delete user profile.

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

Delete user profile.

abstract void deleteById(String id)

Delete user profile.

abstract void deleteByIdWithResponse(String id, Context context)

Delete user profile.

abstract User get(String resourceGroupName, String labName, String name)

Get user profile.

abstract User getById(String id)

Get user profile.

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

Get user profile.

abstract Response<User> getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)

Get user profile.

abstract PagedIterable<User> list(String resourceGroupName, String labName)

List user profiles in a given lab.

abstract PagedIterable<User> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)

List user profiles in a given 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 name)

Delete user profile. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
name - The name of the user profile.

delete

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

Delete user profile. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
name - The name of the user profile.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete user profile. This operation can take a while to complete.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete user profile. This operation can take a while to complete.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract User get(String resourceGroupName, String labName, String name)

Get user profile.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
name - The name of the user profile.

Returns:

user profile.

getById

public abstract User getById(String id)

Get user profile.

Parameters:

id - the resource ID.

Returns:

user profile along with Response<T>.

getByIdWithResponse

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

Get user profile.

Parameters:

id - the resource ID.
expand - Specify the $expand query. Example: 'properties($select=identity)'.
context - The context to associate with this operation.

Returns:

user profile along with Response<T>.

getWithResponse

public abstract Response<User> getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)

Get user profile.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
name - The name of the user profile.
expand - Specify the $expand query. Example: 'properties($select=identity)'.
context - The context to associate with this operation.

Returns:

user profile along with Response<T>.

list

public abstract PagedIterable<User> list(String resourceGroupName, String labName)

List user profiles in a given lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<User> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)

List user profiles in a given lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
expand - Specify the $expand query. Example: 'properties($select=identity)'.
filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
top - The maximum number of resources to return from the operation. Example: '$top=10'.
orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

Applies to