Users interface

Package:

@azure/arm-labservices

Interface representing a Users.

Methods

beginCreateOrUpdate(string, string, string, User, UsersCreateOrUpdateOptionalParams)	Operation to create or update a lab user.
beginCreateOrUpdateAndWait(string, string, string, User, UsersCreateOrUpdateOptionalParams)	Operation to create or update a lab user.
beginDelete(string, string, string, UsersDeleteOptionalParams)	Operation to delete a user resource.
beginDeleteAndWait(string, string, string, UsersDeleteOptionalParams)	Operation to delete a user resource.
beginInvite(string, string, string, InviteBody, UsersInviteOptionalParams)	Operation to invite a user to a lab.
beginInviteAndWait(string, string, string, InviteBody, UsersInviteOptionalParams)	Operation to invite a user to a lab.
beginUpdate(string, string, string, UserUpdate, UsersUpdateOptionalParams)	Operation to update a lab user.
beginUpdateAndWait(string, string, string, UserUpdate, UsersUpdateOptionalParams)	Operation to update a lab user.
get(string, string, string, UsersGetOptionalParams)	Returns the properties of a lab user.
listByLab(string, string, UsersListByLabOptionalParams)	Returns a list of all users for a lab.

Method Details

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

Operation to create or update a lab user.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

body

User

The request body.

options

UsersCreateOrUpdateOptionalParams

The options parameters.

Returns

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

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

Operation to create or update a lab user.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

body

User

The request body.

options

UsersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<User>

beginDelete(string, string, string, UsersDeleteOptionalParams)

Operation to delete a user resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

options

UsersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, UsersDeleteOptionalParams)

Operation to delete a user resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

options

UsersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginInvite(string, string, string, InviteBody, UsersInviteOptionalParams)

Operation to invite a user to a lab.

function beginInvite(resourceGroupName: string, labName: string, userName: string, body: InviteBody, options?: UsersInviteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

body

InviteBody

The request body.

options

UsersInviteOptionalParams

The options parameters.

Returns

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

beginInviteAndWait(string, string, string, InviteBody, UsersInviteOptionalParams)

Operation to invite a user to a lab.

function beginInviteAndWait(resourceGroupName: string, labName: string, userName: string, body: InviteBody, options?: UsersInviteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

body

InviteBody

The request body.

options

UsersInviteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, UserUpdate, UsersUpdateOptionalParams)

Operation to update a lab user.

function beginUpdate(resourceGroupName: string, labName: string, userName: string, body: UserUpdate, options?: UsersUpdateOptionalParams): Promise<PollerLike<PollOperationState<User>, User>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

body

UserUpdate

The request body.

options

UsersUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, UserUpdate, UsersUpdateOptionalParams)

Operation to update a lab user.

function beginUpdateAndWait(resourceGroupName: string, labName: string, userName: string, body: UserUpdate, options?: UsersUpdateOptionalParams): Promise<User>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

body

UserUpdate

The request body.

options

UsersUpdateOptionalParams

The options parameters.

Returns

Promise<User>

get(string, string, string, UsersGetOptionalParams)

Returns the properties of a lab user.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

userName

string

The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

options

UsersGetOptionalParams

The options parameters.

Returns

Promise<User>

listByLab(string, string, UsersListByLabOptionalParams)

Returns a list of all users for a lab.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

labName

string

The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

options

UsersListByLabOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<User, User[], PageSettings>