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 name, UserInner user)

Create or replace an existing user profile.

abstract SyncPoller<PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, UserInner user, Context context)

Create or replace an existing user profile.

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

Delete user profile.

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

Delete user profile.

abstract UserInner createOrUpdate(String resourceGroupName, String labName, String name, UserInner user)

Create or replace an existing user profile.

abstract UserInner createOrUpdate(String resourceGroupName, String labName, String name, UserInner user, Context context)

Create or replace an existing user profile.

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 UserInner get(String resourceGroupName, String labName, String name)

Get user profile.

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

Get user profile.

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

List user profiles in a given lab.

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

List user profiles in a given lab.

abstract UserInner update(String resourceGroupName, String labName, String name, UserFragment user)

Allows modifying tags of user profiles.

abstract Response<UserInner> updateWithResponse(String resourceGroupName, String labName, String name, UserFragment user, Context context)

Allows modifying tags of user profiles.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<UserInner>,UserInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, UserInner user)

Create or replace an existing 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.
user - Profile of a lab user.

Returns:

the SyncPoller<T,U> for polling of a user profile.

beginCreateOrUpdate

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

Create or replace an existing 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.
user - Profile of a lab user.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a user profile.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

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

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

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

createOrUpdate

public abstract UserInner createOrUpdate(String resourceGroupName, String labName, String name, UserInner user)

Create or replace an existing 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.
user - Profile of a lab user.

Returns:

a user profile.

createOrUpdate

public abstract UserInner createOrUpdate(String resourceGroupName, String labName, String name, UserInner user, Context context)

Create or replace an existing 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.
user - Profile of a lab user.
context - The context to associate with this operation.

Returns:

a user profile.

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.

get

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

getWithResponse

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

update

public abstract UserInner update(String resourceGroupName, String labName, String name, UserFragment user)

Allows modifying tags of user profiles. All other properties will be ignored.

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.
user - Profile of a lab user.

Returns:

a user profile.

updateWithResponse

public abstract Response<UserInner> updateWithResponse(String resourceGroupName, String labName, String name, UserFragment user, Context context)

Allows modifying tags of user profiles. All other properties will be ignored.

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.
user - Profile of a lab user.
context - The context to associate with this operation.

Returns:

a user profile along with Response<T>.

Applies to