Share via

Users interface

  • Reference
Package:
@azure/arm-devtestlabs

Interface representing a Users.

Methods

beginCreateOrUpdate(string, string, string, User, UsersCreateOrUpdateOptionalParams)

Create or replace an existing user profile. This operation can take a while to complete.
beginCreateOrUpdateAndWait(string, string, string, User, UsersCreateOrUpdateOptionalParams)

Create or replace an existing user profile. This operation can take a while to complete.
beginDelete(string, string, string, UsersDeleteOptionalParams)

Delete user profile. This operation can take a while to complete.
beginDeleteAndWait(string, string, string, UsersDeleteOptionalParams)

Delete user profile. This operation can take a while to complete.
get(string, string, string, UsersGetOptionalParams)

Get user profile.
list(string, string, UsersListOptionalParams)

List user profiles in a given lab.
update(string, string, string, UserFragment, UsersUpdateOptionalParams)

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

Method Details

beginCreateOrUpdate(string, string, string, User, UsersCreateOrUpdateOptionalParams)

Create or replace an existing user profile. This operation can take a while to complete.

function beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, user: User, options?: UsersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<User>, User>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the user profile.

user
User

Profile of a lab user.

options
UsersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<User>, User>>

beginCreateOrUpdateAndWait(string, string, string, User, UsersCreateOrUpdateOptionalParams)

Create or replace an existing user profile. This operation can take a while to complete.

function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, name: string, user: User, options?: UsersCreateOrUpdateOptionalParams): Promise<User>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the user profile.

user
User

Profile of a lab user.

options
UsersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<User>

beginDelete(string, string, string, UsersDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, labName: string, name: string, options?: UsersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the user profile.

options
UsersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, UsersDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, labName: string, name: string, options?: UsersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the user profile.

options
UsersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, UsersGetOptionalParams)

Get user profile.

function get(resourceGroupName: string, labName: string, name: string, options?: UsersGetOptionalParams): Promise<User>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the user profile.

options
UsersGetOptionalParams

The options parameters.

Returns

Promise<User>

list(string, string, UsersListOptionalParams)

List user profiles in a given lab.

function list(resourceGroupName: string, labName: string, options?: UsersListOptionalParams): PagedAsyncIterableIterator<User, User[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

options
UsersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<User, User[], PageSettings>

update(string, string, string, UserFragment, UsersUpdateOptionalParams)

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

function update(resourceGroupName: string, labName: string, name: string, user: UserFragment, options?: UsersUpdateOptionalParams): Promise<User>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the user profile.

user
UserFragment

Profile of a lab user.

options
UsersUpdateOptionalParams

The options parameters.

Returns

Promise<User>