Virtual Machines - List By Lab

參考

Service:: Lab Services

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
labName	path	True	string	在包含實驗室計劃內唯一識別該實驗室的實驗室名稱。用於資源 URI。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。
$filter	query		string	要套用至作業的篩選條件。

回應

名稱	類型	Description
200 OK	PagedVirtualMachines	要求成功;回應包含指定實驗室的所有虛擬機。
Other Status Codes	ErrorResponse	默認錯誤回應。

範例

listVirtualMachine

Sample Request

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

Sample Response

Status code:: 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"
      }
    }
  ]
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
PagedVirtualMachines	實驗室服務虛擬機的分頁清單。
ProvisioningState	虛擬機目前的布建狀態。
ResourceOperationError	此資源上最新作業失敗的錯誤詳細數據
systemData	與建立和上次修改資源相關的元數據。
VirtualMachine	實驗室虛擬機資源。
VirtualMachineConnectionProfile	虛擬機的連線資訊
VirtualMachineState	虛擬機的狀態。
VirtualMachineType	實驗室虛擬機的類型。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

PagedVirtualMachines

實驗室服務虛擬機的分頁清單。

名稱	類型	Description
nextLink	string	取得虛擬機結果下一頁的連結。
value	VirtualMachine[]	虛擬機結果的數位頁面。

ProvisioningState

虛擬機目前的布建狀態。

名稱	類型	Description
Creating	string	資源正在建立中。
Deleting	string	正在刪除資源。
Failed	string	資源的上一個作業失敗，導致資源處於狀況不良狀態。
Locked	string	資源已鎖定，且目前已封鎖變更。這可能是因為維護或排程的作業所造成。鎖定作業完成後，狀態會回復為成功。
Succeeded	string	資源在建立或更新作業之後處於狀況良好的狀態。
Updating	string	新的屬性值會套用至資源。

ResourceOperationError

此資源上最新作業失敗的錯誤詳細數據

名稱	類型	Description
action	string	失敗的作業動作
code	string	對應至作業失敗類型的程序代碼
message	string	作業失敗訊息
timestamp	string	發生錯誤的日期時間

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

VirtualMachine

實驗室虛擬機資源。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.claimedByUserId	string	實驗室用戶標識碼 (不是宣告虛擬機的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

虛擬機的連線資訊

名稱	類型	Description
adminUsername	string	用來以系統管理員身分登入虛擬機的用戶名稱。
nonAdminUsername	string	如果使用者存在，用來以非系統管理員身分登入虛擬機的用戶名稱。
privateIpAddress	string	虛擬機的私人IP位址。
rdpAuthority	string	透過 RDP 通訊協定連線至虛擬機的埠和主機名，以分號分隔。
rdpInBrowserUrl	string	透過 RDP 通訊協定連線至瀏覽器中虛擬機的 URL。
sshAuthority	string	透過 SSH 通訊協定連線至虛擬機的埠和主機名，以分號分隔。
sshInBrowserUrl	string	透過 SSH 通訊協定連線至瀏覽器中虛擬機的 URL。

VirtualMachineState

虛擬機的狀態。

名稱	類型	Description
Redeploying	string	正在重新部署 VM。
Reimaging	string	VM 正在重新製作映像。
ResettingPassword	string	VM 密碼正在重設。
Running	string	VM 正在執行。
Starting	string	VM 正在啟動。
Stopped	string	VM 目前已停止。
Stopping	string	VM 正在停止。

VirtualMachineType

實驗室虛擬機的類型。

名稱	類型	Description
Template	string	範本 VM
User	string	使用者 VM

Virtual Machines - List By Lab

URI 參數

回應

範例

listVirtualMachine

Sample Request

Sample Response

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType

其他資源