你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Global Users - List Environments

Service:

Lab Services

API Version:

2018-10-15

列出用户的环境

POST https://management.azure.com/providers/Microsoft.LabServices/users/{userName}/listEnvironments?api-version=2018-10-15

URI 参数

名称	在	必需	类型	说明
userName	path	True	string	用户的名称。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
labId	string	实验室的资源 ID

响应

名称	类型	说明
200 OK	ListEnvironmentsResponse	确定
Other Status Codes	CloudError	BadRequest

安全性

azure_auth

OAuth2 隐式授权

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	访问 Microsoft Azure

定义

名称	说明
CloudError	REST 请求出错。
CloudErrorBody	来自 REST 请求的错误正文。
EnvironmentDetails	这表示有关用户环境及其状态的详细信息。
LatestOperationResult	操作状态的详细信息。
ListEnvironmentsPayload	表示列出用户拥有的环境的有效负载
ListEnvironmentsResponse	表示用户拥有的环境列表
VirtualMachineDetails	支持虚拟机的详细信息。

CloudError

REST 请求出错。

名称	类型	说明
error	CloudErrorBody	来自 REST 请求的错误正文。

CloudErrorBody

来自 REST 请求的错误正文。

名称	类型	说明
code	string
details	CloudErrorBody[]	内部错误。
message	string
target	string

EnvironmentDetails

这表示有关用户环境及其状态的详细信息。

名称	类型	说明
description	string	环境说明
environmentState	string	环境的发布状态设置可能的值是 Creating、Created、Failed
id	string	环境的资源 ID
latestOperationResult	LatestOperationResult	最新操作的详细信息。 例如：状态、错误
name	string	环境的名称
passwordLastReset	string	上次在环境中重置密码时。
provisioningState	string	环境的预配状态。 这还包括 LabIsFull 和 NotYetProvisioned 状态。
totalUsage	string	实验室用户使用环境的时间
virtualMachineDetails	VirtualMachineDetails	支持 DTL 虚拟机的详细信息，以及计算和网络详细信息。

LatestOperationResult

操作状态的详细信息。

名称	类型	说明
errorCode	string	失败时的错误代码。
errorMessage	string	错误消息。
httpMethod	string	操作的 HttpMethod - PUT/POST/DELETE。
operationUrl	string	用于检查长时间运行的操作状态的 URL
requestUri	string	操作的请求 URI。
status	string	操作的当前状态。

ListEnvironmentsPayload

表示列出用户拥有的环境的有效负载

名称	类型	说明
labId	string	实验室的资源 ID

ListEnvironmentsResponse

表示用户拥有的环境列表

名称	类型	说明
environments	EnvironmentDetails[]	所有环境的列表

VirtualMachineDetails

支持虚拟机的详细信息。

名称	类型	说明
lastKnownPowerState	string	在 DTL 中捕获的上一个已知计算电源状态
privateIpAddress	string	计算 VM 的 PrivateIp 地址
provisioningState	string	Dtl VM 的预配状态
rdpAuthority	string	Windows 的连接信息
sshAuthority	string	适用于 Linux 的连接信息
userName	string	计算 VM 登录用户名