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

Virtual Machines - List By Lab

参考

服务:: Lab Services

API 版本:: 2023-06-07

获取实验室的所有虚拟机。
返回实验室的所有虚拟机的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

URI 参数

名称	在	必需	类型	说明
labName	path	True	string minLength: 1 maxLength: 100	在包含的实验室计划中唯一标识它的实验室的名称。在资源 URI 中使用。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
$filter	query		string	要应用于操作的筛选器。

响应

名称	类型	说明
200 OK	PagedVirtualMachines	请求成功;响应包含给定实验室的所有虚拟机。
Other Status Codes	ErrorResponse	默认错误响应。

示例

listVirtualMachine

示例请求

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines?api-version=2023-06-07

示例响应

状态代码:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines/template",
      "name": "default",
      "type": "Microsoft.LabServices/VirtualMachine",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Running",
        "connectionProfile": {
          "privateIpAddress": "192.168.2.1",
          "sshAuthority": "vm-42.contoso.com:22",
          "sshInBrowserUrl": "vm-42.contoso.com",
          "rdpAuthority": "vm-42.contoso.com:3389",
          "rdpInBrowserUrl": "vm-42.contoso.com",
          "adminUsername": "user123"
        },
        "claimedByUserId": "testuser567",
        "vmType": "Template"
      }
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
PagedVirtualMachines	实验室服务虚拟机的分页列表。
ProvisioningState	虚拟机的当前预配状态。
ResourceOperationError	此资源上的最新操作失败的错误详细信息
systemData	与资源的创建和上次修改相关的元数据。
VirtualMachine	实验室虚拟机资源。
VirtualMachineConnectionProfile	虚拟机的连接信息
VirtualMachineState	虚拟机的状态。
VirtualMachineType	实验室虚拟机的类型。

createdByType

枚举

创建资源的标识类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

PagedVirtualMachines

Object

实验室服务虚拟机的分页列表。

名称	类型	说明
nextLink	string	用于获取虚拟机结果的下一页的链接。
value	VirtualMachine[]	虚拟机结果的数组页。

ProvisioningState

枚举

虚拟机的当前预配状态。

值	说明
Creating	正在创建资源。
Deleting	正在删除资源。
Failed	以前对资源执行的操作失败，使资源处于不正常状态。
Locked	资源已锁定，并且当前阻止更改。这可能是由于维护或计划的操作造成的。锁定操作完成后，状态将恢复为成功。
Succeeded	资源在创建或更新操作后处于正常状态。
Updating	正在向资源应用新的属性值。

ResourceOperationError

Object

此资源上的最新操作失败的错误详细信息

名称	类型	说明
action	string	失败的操作操作
code	string	对应于操作失败类型的代码
message	string	操作失败消息
timestamp	string (date-time)	发生错误的日期时间

systemData

Object

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

VirtualMachine

Object

实验室虚拟机资源。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.claimedByUserId	string	实验室用户 ID (而不是声明虚拟机的用户的 PUID！) 。
properties.connectionProfile	VirtualMachineConnectionProfile	有关连接到虚拟机的信息的配置文件。
properties.provisioningState	ProvisioningState	虚拟机的当前预配状态。
properties.resourceOperationError	ResourceOperationError	对实验室计划执行的最后一个操作的错误详细信息。
properties.state	VirtualMachineState	虚拟机的当前状态
properties.vmType	VirtualMachineType	此 VM 资源的类型
systemData	systemData	实验室虚拟机的系统数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

VirtualMachineConnectionProfile

Object

虚拟机的连接信息

名称	类型	说明
adminUsername	string	用于以管理员身份登录到虚拟机的用户名。
nonAdminUsername	string	用于以非管理员身份登录到虚拟机的用户名（如果存在）。
privateIpAddress	string	虚拟机的专用 IP 地址。
rdpAuthority	string	端口和主机名用分号分隔，用于通过 RDP 协议连接到虚拟机。
rdpInBrowserUrl	string minLength: 3 maxLength: 2000	用于在浏览器中通过 RDP 协议连接到虚拟机的 URL。
sshAuthority	string	端口和主机名用分号分隔，用于通过 SSH 协议连接到虚拟机。
sshInBrowserUrl	string minLength: 3 maxLength: 2000	用于在浏览器中通过 SSH 协议连接到虚拟机的 URL。

VirtualMachineState

枚举

虚拟机的状态。

值	说明
Redeploying	正在重新部署 VM。
Reimaging	VM 正在重置映像。
ResettingPassword	正在重置 VM 密码。
Running	VM 正在运行。
Starting	VM 正在启动。
Stopped	VM 当前已停止。
Stopping	VM 正在停止。

VirtualMachineType

枚举

实验室虚拟机的类型。

值	说明
Template	模板 VM
User	用户 VM

通过

Virtual Machines - List By Lab

URI 参数

响应

示例

listVirtualMachine

示例请求

示例响应

定义

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType

其他资源