Global Users - List Environments
List Environments for the user
POST https://management.azure.com/providers/Microsoft.LabServices/users/{userName}/listEnvironments?api-version=2018-10-15URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
user
|
path | True |
string |
The name of the user. |
|
api-version
|
query | True |
string |
Client API version. |
Request Body
| Name | Type | Description |
|---|---|---|
| labId |
string |
The resource Id of the lab |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
BadRequest |
Security
azure_auth
OAuth2 Implicit Grant
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | Access Microsoft Azure |
Definitions
| Name | Description |
|---|---|
|
Cloud |
Error from a REST request. |
|
Cloud |
Body of an error from a REST request. |
|
Environment |
This represents the details about a User's environment and its state. |
|
Latest |
Details of the status of an operation. |
|
List |
Represents the payload to list environments owned by a user |
|
List |
Represents the list of environments owned by a user |
|
Virtual |
Details of the backing virtual machine. |
CloudError
Error from a REST request.
| Name | Type | Description |
|---|---|---|
| error |
Body of an error from a REST request. |
CloudErrorBody
Body of an error from a REST request.
| Name | Type | Description |
|---|---|---|
| code |
string |
|
| details |
Inner errors. |
|
| message |
string |
|
| target |
string |
EnvironmentDetails
This represents the details about a User's environment and its state.
| Name | Type | Description |
|---|---|---|
| description |
string |
Description of the Environment |
| environmentState |
string |
Publishing state of the environment setting Possible values are Creating, Created, Failed |
| id |
string |
Resource Id of the environment |
| latestOperationResult |
The details of the latest operation. ex: status, error |
|
| name |
string |
Name of the Environment |
| passwordLastReset |
string |
When the password was last reset on the environment. |
| provisioningState |
string |
The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. |
| totalUsage |
string |
How long the environment has been used by a lab user |
| virtualMachineDetails |
Details of backing DTL virtual machine with compute and network details. |
LatestOperationResult
Details of the status of an operation.
| Name | Type | Description |
|---|---|---|
| errorCode |
string |
Error code on failure. |
| errorMessage |
string |
The error message. |
| httpMethod |
string |
The HttpMethod - PUT/POST/DELETE for the operation. |
| operationUrl |
string |
The URL to use to check long-running operation status |
| requestUri |
string |
Request URI of the operation. |
| status |
string |
The current status of the operation. |
ListEnvironmentsPayload
Represents the payload to list environments owned by a user
| Name | Type | Description |
|---|---|---|
| labId |
string |
The resource Id of the lab |
ListEnvironmentsResponse
Represents the list of environments owned by a user
| Name | Type | Description |
|---|---|---|
| environments |
List of all the environments |
VirtualMachineDetails
Details of the backing virtual machine.
| Name | Type | Description |
|---|---|---|
| lastKnownPowerState |
string |
Last known compute power state captured in DTL |
| privateIpAddress |
string |
PrivateIp address of the compute VM |
| provisioningState |
string |
Provisioning state of the Dtl VM |
| rdpAuthority |
string |
Connection information for Windows |
| sshAuthority |
string |
Connection information for Linux |
| userName |
string |
Compute VM login user name |