Users | @azure/arm-devtestlabs

Class representing a Users.

Hierarchy

Users

Index

Constructors

constructor

Methods

Constructors

constructor

new Users(client: DevTestLabsClientContext): Users

- Defined in operations/users.ts:20
Create a Users.

Parameters
- client: DevTestLabsClientContext
  
  Reference to the service client.
Returns Users

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, user: User, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/users.ts:174
Create or replace an existing user profile. This operation can take a while to complete.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/users.ts:195
Delete user profile. This operation can take a while to complete.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- name: string
  
  The name of the user profile.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(resourceGroupName: string, labName: string, name: string, user: User, options?: msRest.RequestOptionsBase): Promise<Models.UsersCreateOrUpdateResponse>

- Defined in operations/users.ts:107
Create or replace an existing user profile. This operation can take a while to complete.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.UsersCreateOrUpdateResponse>

Promise<Models.UsersCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/users.ts:120
Delete user profile. This operation can take a while to complete.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- name: string
  
  The name of the user profile.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(resourceGroupName: string, labName: string, name: string, options?: Models.UsersGetOptionalParams): Promise<Models.UsersGetResponse>
get(resourceGroupName: string, labName: string, name: string, callback: msRest.ServiceCallback<User>): void
get(resourceGroupName: string, labName: string, name: string, options: UsersGetOptionalParams, callback: msRest.ServiceCallback<User>): void

- Defined in operations/users.ts:70
Get user profile.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- name: string
  
  The name of the user profile.
- Optional options: Models.UsersGetOptionalParams
Returns Promise<Models.UsersGetResponse>

Promise<Models.UsersGetResponse>
- Defined in operations/users.ts:77
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- name: string
  
  The name of the user profile.
- callback: msRest.ServiceCallback<User>
  
  The callback
Returns void
- Defined in operations/users.ts:85
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 optional parameters
- callback: msRest.ServiceCallback<User>
  
  The callback
Returns void

list

list(resourceGroupName: string, labName: string, options?: Models.UsersListOptionalParams): Promise<Models.UsersListResponse>
list(resourceGroupName: string, labName: string, callback: msRest.ServiceCallback<UserList>): void
list(resourceGroupName: string, labName: string, options: UsersListOptionalParams, callback: msRest.ServiceCallback<UserList>): void

- Defined in operations/users.ts:37
List user profiles in a given lab.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- Optional options: Models.UsersListOptionalParams
Returns Promise<Models.UsersListResponse>

Promise<Models.UsersListResponse>
- Defined in operations/users.ts:43
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- callback: msRest.ServiceCallback<UserList>
  
  The callback
Returns void
- Defined in operations/users.ts:50
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labName: string
  
  The name of the lab.
- options: UsersListOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<UserList>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.UsersListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<UserList>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<UserList>): void

- Defined in operations/users.ts:213
List user profiles in a given lab.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.UsersListNextResponse>

Promise<Models.UsersListNextResponse>
- Defined in operations/users.ts:218
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<UserList>
  
  The callback
Returns void
- Defined in operations/users.ts:224
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<UserList>
  
  The callback
Returns void

update

update(resourceGroupName: string, labName: string, name: string, user: UserFragment, options?: msRest.RequestOptionsBase): Promise<Models.UsersUpdateResponse>
update(resourceGroupName: string, labName: string, name: string, user: UserFragment, callback: msRest.ServiceCallback<User>): void
update(resourceGroupName: string, labName: string, name: string, user: UserFragment, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<User>): void

- Defined in operations/users.ts:134
Modify properties of user profiles.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.UsersUpdateResponse>

Promise<Models.UsersUpdateResponse>
- Defined in operations/users.ts:142
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.
- callback: msRest.ServiceCallback<User>
  
  The callback
Returns void
- Defined in operations/users.ts:151
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: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<User>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: DevTestLabsClientContext

Returns Users

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

labName: string

name: string

user: User

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

labName: string

name: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

resourceGroupName: string

labName: string

name: string

user: User

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.UsersCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

labName: string

name: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

get

Parameters

resourceGroupName: string

labName: string

name: string

Optional options: Models.UsersGetOptionalParams

Returns Promise<Models.UsersGetResponse>

Parameters

resourceGroupName: string

labName: string

name: string

callback: msRest.ServiceCallback<User>

Returns void

Parameters

resourceGroupName: string

labName: string

name: string

options: UsersGetOptionalParams

callback: msRest.ServiceCallback<User>

Returns void

list

Parameters

resourceGroupName: string

labName: string

Optional options: Models.UsersListOptionalParams

Returns Promise<Models.UsersListResponse>

Parameters

resourceGroupName: string

labName: string

callback: msRest.ServiceCallback<UserList>

Returns void

Parameters

resourceGroupName: string

labName: string

options: UsersListOptionalParams

callback: msRest.ServiceCallback<UserList>

Returns void

listNext

Parameters

nextPageLink: string