GlobalUsers | @azure/arm-labservices

Class representing a GlobalUsers.

Hierarchy

GlobalUsers

Index

Constructors

constructor

Methods

Constructors

constructor

new GlobalUsers(client: ManagedLabsClientContext): GlobalUsers

- Defined in operations/globalUsers.ts:20
Create a GlobalUsers.

Parameters
- client: ManagedLabsClientContext
  
  Reference to the service client.
Returns GlobalUsers

Methods

beginResetPassword

beginResetPassword(userName: string, resetPasswordPayload: ResetPasswordPayload, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/globalUsers.ts:303
Resets the user password on an environment This operation can take a while to complete

Parameters
- userName: string
  
  The name of the user.
- resetPasswordPayload: ResetPasswordPayload
  
  Represents the payload for resetting passwords.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStartEnvironment

beginStartEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/globalUsers.ts:323
Starts an environment by starting all resources inside the environment. This operation can take a while to complete

Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStopEnvironment

beginStopEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/globalUsers.ts:343
Stops an environment by stopping all resources inside the environment This operation can take a while to complete

Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

getEnvironment

getEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, options?: Models.GlobalUsersGetEnvironmentOptionalParams): Promise<Models.GlobalUsersGetEnvironmentResponse>
getEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, callback: msRest.ServiceCallback<GetEnvironmentResponse>): void
getEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, options: GlobalUsersGetEnvironmentOptionalParams, callback: msRest.ServiceCallback<GetEnvironmentResponse>): void

- Defined in operations/globalUsers.ts:38
Gets the virtual machine details

Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- Optional options: Models.GlobalUsersGetEnvironmentOptionalParams
Returns Promise<Models.GlobalUsersGetEnvironmentResponse>

Promise<Models.GlobalUsersGetEnvironmentResponse>
- Defined in operations/globalUsers.ts:45
Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- callback: msRest.ServiceCallback<GetEnvironmentResponse>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:53
Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- options: GlobalUsersGetEnvironmentOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<GetEnvironmentResponse>
  
  The callback
Returns void

getOperationBatchStatus

getOperationBatchStatus(userName: string, operationBatchStatusPayload: OperationBatchStatusPayload, options?: msRest.RequestOptionsBase): Promise<Models.GlobalUsersGetOperationBatchStatusResponse>
getOperationBatchStatus(userName: string, operationBatchStatusPayload: OperationBatchStatusPayload, callback: msRest.ServiceCallback<OperationBatchStatusResponse>): void
getOperationBatchStatus(userName: string, operationBatchStatusPayload: OperationBatchStatusPayload, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<OperationBatchStatusResponse>): void

- Defined in operations/globalUsers.ts:72
Get batch operation status

Parameters
- userName: string
  
  The name of the user.
- operationBatchStatusPayload: OperationBatchStatusPayload
  
  Payload to get the status of an operation
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.GlobalUsersGetOperationBatchStatusResponse>

Promise<Models.GlobalUsersGetOperationBatchStatusResponse>
- Defined in operations/globalUsers.ts:78
Parameters
- userName: string
  
  The name of the user.
- operationBatchStatusPayload: OperationBatchStatusPayload
  
  Payload to get the status of an operation
- callback: msRest.ServiceCallback<OperationBatchStatusResponse>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:85
Parameters
- userName: string
  
  The name of the user.
- operationBatchStatusPayload: OperationBatchStatusPayload
  
  Payload to get the status of an operation
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<OperationBatchStatusResponse>
  
  The callback
Returns void

getOperationStatus

getOperationStatus(userName: string, operationStatusPayload: OperationStatusPayload, options?: msRest.RequestOptionsBase): Promise<Models.GlobalUsersGetOperationStatusResponse>
getOperationStatus(userName: string, operationStatusPayload: OperationStatusPayload, callback: msRest.ServiceCallback<OperationStatusResponse>): void
getOperationStatus(userName: string, operationStatusPayload: OperationStatusPayload, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<OperationStatusResponse>): void

- Defined in operations/globalUsers.ts:104
Gets the status of long running operation

Parameters
- userName: string
  
  The name of the user.
- operationStatusPayload: OperationStatusPayload
  
  Payload to get the status of an operation
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.GlobalUsersGetOperationStatusResponse>

Promise<Models.GlobalUsersGetOperationStatusResponse>
- Defined in operations/globalUsers.ts:110
Parameters
- userName: string
  
  The name of the user.
- operationStatusPayload: OperationStatusPayload
  
  Payload to get the status of an operation
- callback: msRest.ServiceCallback<OperationStatusResponse>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:117
Parameters
- userName: string
  
  The name of the user.
- operationStatusPayload: OperationStatusPayload
  
  Payload to get the status of an operation
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<OperationStatusResponse>
  
  The callback
Returns void

getPersonalPreferences

getPersonalPreferences(userName: string, personalPreferencesOperationsPayload: PersonalPreferencesOperationsPayload, options?: msRest.RequestOptionsBase): Promise<Models.GlobalUsersGetPersonalPreferencesResponse>
getPersonalPreferences(userName: string, personalPreferencesOperationsPayload: PersonalPreferencesOperationsPayload, callback: msRest.ServiceCallback<GetPersonalPreferencesResponse>): void
getPersonalPreferences(userName: string, personalPreferencesOperationsPayload: PersonalPreferencesOperationsPayload, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GetPersonalPreferencesResponse>): void

- Defined in operations/globalUsers.ts:137
Get personal preferences for a user

Parameters
- userName: string
  
  The name of the user.
- personalPreferencesOperationsPayload: PersonalPreferencesOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.GlobalUsersGetPersonalPreferencesResponse>

Promise<Models.GlobalUsersGetPersonalPreferencesResponse>
- Defined in operations/globalUsers.ts:144
Parameters
- userName: string
  
  The name of the user.
- personalPreferencesOperationsPayload: PersonalPreferencesOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- callback: msRest.ServiceCallback<GetPersonalPreferencesResponse>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:152
Parameters
- userName: string
  
  The name of the user.
- personalPreferencesOperationsPayload: PersonalPreferencesOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<GetPersonalPreferencesResponse>
  
  The callback
Returns void

listEnvironments

listEnvironments(userName: string, listEnvironmentsPayload: ListEnvironmentsPayload, options?: msRest.RequestOptionsBase): Promise<Models.GlobalUsersListEnvironmentsResponse>
listEnvironments(userName: string, listEnvironmentsPayload: ListEnvironmentsPayload, callback: msRest.ServiceCallback<ListEnvironmentsResponse>): void
listEnvironments(userName: string, listEnvironmentsPayload: ListEnvironmentsPayload, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ListEnvironmentsResponse>): void

- Defined in operations/globalUsers.ts:171
List Environments for the user

Parameters
- userName: string
  
  The name of the user.
- listEnvironmentsPayload: ListEnvironmentsPayload
  
  Represents the payload to list environments owned by a user
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.GlobalUsersListEnvironmentsResponse>

Promise<Models.GlobalUsersListEnvironmentsResponse>
- Defined in operations/globalUsers.ts:177
Parameters
- userName: string
  
  The name of the user.
- listEnvironmentsPayload: ListEnvironmentsPayload
  
  Represents the payload to list environments owned by a user
- callback: msRest.ServiceCallback<ListEnvironmentsResponse>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:184
Parameters
- userName: string
  
  The name of the user.
- listEnvironmentsPayload: ListEnvironmentsPayload
  
  Represents the payload to list environments owned by a user
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ListEnvironmentsResponse>
  
  The callback
Returns void

listLabs

listLabs(userName: string, options?: msRest.RequestOptionsBase): Promise<Models.GlobalUsersListLabsResponse>
listLabs(userName: string, callback: msRest.ServiceCallback<ListLabsResponse>): void
listLabs(userName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ListLabsResponse>): void

- Defined in operations/globalUsers.ts:202
List labs for the user.

Parameters
- userName: string
  
  The name of the user.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.GlobalUsersListLabsResponse>

Promise<Models.GlobalUsersListLabsResponse>
- Defined in operations/globalUsers.ts:207
Parameters
- userName: string
  
  The name of the user.
- callback: msRest.ServiceCallback<ListLabsResponse>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:213
Parameters
- userName: string
  
  The name of the user.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ListLabsResponse>
  
  The callback
Returns void

register

register(userName: string, registerPayload: RegisterPayload, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
register(userName: string, registerPayload: RegisterPayload, callback: msRest.ServiceCallback<void>): void
register(userName: string, registerPayload: RegisterPayload, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/globalUsers.ts:231
Register a user to a managed lab

Parameters
- userName: string
  
  The name of the user.
- registerPayload: RegisterPayload
  
  Represents payload for Register action.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/globalUsers.ts:237
Parameters
- userName: string
  
  The name of the user.
- registerPayload: RegisterPayload
  
  Represents payload for Register action.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/globalUsers.ts:244
Parameters
- userName: string
  
  The name of the user.
- registerPayload: RegisterPayload
  
  Represents payload for Register action.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

resetPassword

resetPassword(userName: string, resetPasswordPayload: ResetPasswordPayload, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/globalUsers.ts:263
Resets the user password on an environment This operation can take a while to complete

Parameters
- userName: string
  
  The name of the user.
- resetPasswordPayload: ResetPasswordPayload
  
  Represents the payload for resetting passwords.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

startEnvironment

startEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/globalUsers.ts:277
Starts an environment by starting all resources inside the environment. This operation can take a while to complete

Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

stopEnvironment

stopEnvironment(userName: string, environmentOperationsPayload: EnvironmentOperationsPayload, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/globalUsers.ts:291
Stops an environment by stopping all resources inside the environment This operation can take a while to complete

Parameters
- userName: string
  
  The name of the user.
- environmentOperationsPayload: EnvironmentOperationsPayload
  
  Represents payload for any Environment operations like get, start, stop, connect
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ManagedLabsClientContext

Returns GlobalUsers

Methods

beginResetPassword

Parameters

userName: string

resetPasswordPayload: ResetPasswordPayload

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStartEnvironment

Parameters

userName: string

environmentOperationsPayload: EnvironmentOperationsPayload

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStopEnvironment

Parameters

userName: string

environmentOperationsPayload: EnvironmentOperationsPayload

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

getEnvironment

Parameters

userName: string

environmentOperationsPayload: EnvironmentOperationsPayload

Optional options: Models.GlobalUsersGetEnvironmentOptionalParams

Returns Promise<Models.GlobalUsersGetEnvironmentResponse>

Parameters

userName: string

environmentOperationsPayload: EnvironmentOperationsPayload

callback: msRest.ServiceCallback<GetEnvironmentResponse>

Returns void

Parameters

userName: string

environmentOperationsPayload: EnvironmentOperationsPayload

options: GlobalUsersGetEnvironmentOptionalParams

callback: msRest.ServiceCallback<GetEnvironmentResponse>

Returns void

getOperationBatchStatus

Parameters

userName: string

operationBatchStatusPayload: OperationBatchStatusPayload

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.GlobalUsersGetOperationBatchStatusResponse>

Parameters

userName: string

operationBatchStatusPayload: OperationBatchStatusPayload

callback: msRest.ServiceCallback<OperationBatchStatusResponse>

Returns void

Parameters

userName: string

operationBatchStatusPayload: OperationBatchStatusPayload

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<OperationBatchStatusResponse>

Returns void

getOperationStatus

Parameters

userName: string

operationStatusPayload: OperationStatusPayload

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.GlobalUsersGetOperationStatusResponse>

Parameters

userName: string

operationStatusPayload: OperationStatusPayload

callback: msRest.ServiceCallback<OperationStatusResponse>

Returns void

Parameters

userName: string

operationStatusPayload: OperationStatusPayload

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<OperationStatusResponse>

Returns void

getPersonalPreferences