共用方式為

Virtual Machines - List

  • 參考
服務:
Dev Test Labs
API 版本:
2018-09-15

列出指定實驗室中的虛擬機。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15
含選擇性參數: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI 參數

名稱 位於 必要 類型 Description
labName
 path True

string

實驗室的名稱。
resourceGroupName
 path True

string

資源群組的名稱。
subscriptionId
 path True

string

訂閱識別碼。
api-version
 query True

string

用戶端 API 版本。
$expand
 query

string

指定$expand查詢。 範例：'properties ($expand=artifacts，computeVm，networkInterface，applicableSchedule) '
$filter
 query

string

要套用至作業的篩選條件。 範例：『$filter=contains (name，'myName')

$orderby
 query

string

使用 OData 表示法排序結果的表達式。 範例：'$orderby=name desc'
$top
 query

integer

int32

要從作業傳回的資源數目上限。 範例：'$top=10'

回應

名稱 類型 Description
200 OK

LabVirtualMachineList

確定
Other Status Codes

CloudError

BadRequest

安全性

azure_auth

OAuth2 隱含授與

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 存取 Microsoft Azure

範例

VirtualMachines_List

範例要求

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15

範例回覆

狀態碼:
200 
{
  "value": [
    {
      "properties": {
        "ownerObjectId": "",
        "ownerUserPrincipalName": "",
        "createdByUserId": "",
        "createdByUser": "",
        "createdDate": "2018-10-01T16:53:02.4830866-07:00",
        "computeId": "/subscriptions/{subscriptionId}/resourceGroups/{labName}-{vmName}-{randomSuffix}/providers/Microsoft.Compute/virtualMachines/{vmName}",
        "osType": "Linux",
        "size": "Standard_A2_v2",
        "userName": "{userName}",
        "labSubnetName": "{virtualNetworkName}Subnet",
        "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
        "disallowPublicIpAddress": true,
        "artifactDeploymentStatus": {
          "artifactsApplied": 0,
          "totalArtifacts": 0
        },
        "galleryImageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "16.04-LTS",
          "osType": "Linux",
          "version": "Latest"
        },
        "networkInterface": {},
        "allowClaim": true,
        "storageType": "Standard",
        "virtualMachineCreationSource": "FromGalleryImage",
        "dataDiskParameters": [],
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
      "name": "{vmName}",
      "type": "Microsoft.DevTestLab/labs/virtualMachines",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

定義

名稱 Description
ApplicableSchedule

適用於虛擬機的排程。 排程可能已在 VM 或實驗室層級上定義。
ArtifactDeploymentStatusProperties

成品部署的屬性。
ArtifactInstallProperties

成品的屬性。
ArtifactParameterProperties

成品參數的屬性。
AttachNewDataDiskOptions

將新磁碟連結至虛擬機的屬性。
CloudError

REST 要求發生錯誤。
CloudErrorBody

REST 要求的錯誤本文。
ComputeDataDisk

連結至虛擬機的數據磁碟。
ComputeVmInstanceViewStatus

虛擬機的狀態資訊。
ComputeVmProperties

Microsoft.Compute API 所傳回之虛擬機的屬性。
DataDiskProperties

要求將新的或現有的數據磁碟新增至虛擬機的本文。
DayDetails

每日排程的屬性。
EnableStatus

排程 (的狀態，也就是 [已啟用]、[已停用])

GalleryImageReference

Azure Marketplace 映像的參考資訊。
HostCachingOptions

數據磁碟的快取選項 (例如 None、ReadOnly、ReadWrite) 。
HourDetails

每小時排程的屬性。
InboundNatRule

NAT 的規則 - 使用負載平衡器在公用 IP 位址上公開 VM 的埠 (backendPort) 。
LabVirtualMachine

虛擬機器。
LabVirtualMachineList

清單作業的回應。
NetworkInterfaceProperties

網路介面的屬性。
NotificationSettings

排程的通知設定。
Schedule

排程。
ScheduleCreationParameter

用於建立排程的屬性。
SharedPublicIpAddressConfiguration

決定其如何連線至負載平衡器的虛擬機屬性。
StorageType

磁碟 (的記憶體類型，也就是標準、進階) 。
TransportProtocol

端點的傳輸通訊協定。
VirtualMachineCreationSource

告知實驗室虛擬機的建立來源。 僅限輸出屬性。
WeekDetails

每周排程的屬性。

ApplicableSchedule

適用於虛擬機的排程。 排程可能已在 VM 或實驗室層級上定義。

名稱 類型 Description
id

string

資源的標識碼。
location

string

資源的位置。
name

string

資源名稱。
properties.labVmsShutdown

Schedule

如果已在實驗室或實驗室資源層級設定自動關機排程。
properties.labVmsStartup

Schedule

如果已在實驗室或實驗室資源層級設定自動啟動排程。
tags

object

資源的標記。
type

string

資源類型。

ArtifactDeploymentStatusProperties

成品部署的屬性。

名稱 類型 Description
artifactsApplied

integer

已成功套用的成品總數。
deploymentStatus

string

成品的部署狀態。
totalArtifacts

integer

已暫訂套用的成品總數。

ArtifactInstallProperties

成品的屬性。

名稱 類型 Description
artifactId

string

成品的標識碼。
artifactTitle

string

成品的標題。
deploymentStatusMessage

string

來自部署的狀態消息。
installTime

string

成品開始在虛擬機上安裝的時間。
parameters

ArtifactParameterProperties[]

成品的參數。
status

string

成品的狀態。
vmExtensionStatusMessage

string

虛擬機擴充功能的狀態消息。

ArtifactParameterProperties

成品參數的屬性。

名稱 類型 Description
name

string

成品參數的名稱。
value

string

成品參數的值。

AttachNewDataDiskOptions

將新磁碟連結至虛擬機的屬性。

名稱 類型 Description
diskName

string

要連接的磁碟名稱。
diskSizeGiB

integer

要以 Gibibytes 連接之磁碟的大小。
diskType

StorageType

磁碟 (的記憶體類型，也就是標準、進階) 。

CloudError

REST 要求發生錯誤。

名稱 類型 Description
error

CloudErrorBody

發生的雲端錯誤

CloudErrorBody

REST 要求的錯誤本文。

名稱 類型 Description
code

string

錯誤碼。
details

CloudErrorBody[]

內部錯誤。
message

string

錯誤訊息。
target

string

錯誤目標。

ComputeDataDisk

連結至虛擬機的數據磁碟。

名稱 類型 Description
diskSizeGiB

integer

取得 GiB 中的數據磁碟大小。
diskUri

string

由 Blob 支援時，基礎 Blob 的 URI。
managedDiskId

string

受受控磁碟支援時，這是計算磁碟資源的標識碼。
name

string

取得數據磁碟名稱。

ComputeVmInstanceViewStatus

虛擬機的狀態資訊。

名稱 類型 Description
code

string

取得狀態代碼。
displayStatus

string

取得狀態的簡短可本地化標籤。
message

string

取得與狀態相關聯的訊息。

ComputeVmProperties

Microsoft.Compute API 所傳回之虛擬機的屬性。

名稱 類型 Description
dataDiskIds

string[]

取得虛擬機的數據磁碟 Blob URI。
dataDisks

ComputeDataDisk[]

取得連結至虛擬機的所有數據磁碟。
networkInterfaceId

string

取得虛擬機的網路介面標識碼。
osDiskId

string

取得虛擬機的 OS 磁碟 Blob URI。
osType

string

取得虛擬機的 OS 類型。
statuses

ComputeVmInstanceViewStatus[]

取得虛擬機的狀態。
vmSize

string

取得虛擬機的大小。

DataDiskProperties

要求將新的或現有的數據磁碟新增至虛擬機的本文。

名稱 類型 Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

指定將新磁碟連結至虛擬機的選項。
existingLabDiskId

string

指定要連結至虛擬機的現有實驗室磁碟標識碼。
hostCaching

HostCachingOptions

數據磁碟的快取選項 (例如 None、ReadOnly、ReadWrite) 。

DayDetails

每日排程的屬性。

名稱 類型 Description
time

string

排程將發生的一天時間。

EnableStatus

排程 (的狀態，也就是 [已啟用]、[已停用])

名稱 類型 Description
Disabled

string

Enabled

string

GalleryImageReference

Azure Marketplace 映像的參考資訊。

名稱 類型 Description
offer

string

資源庫映像的供應專案。
osType

string

資源庫映像的OS類型。
publisher

string

資源庫映像的發行者。
sku

string

資源庫映像的SKU。
version

string

資源庫映像的版本。

HostCachingOptions

數據磁碟的快取選項 (例如 None、ReadOnly、ReadWrite) 。

名稱 類型 Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

每小時排程的屬性。

名稱 類型 Description
minute

integer

排程將執行的小時分鐘數。

InboundNatRule

NAT 的規則 - 使用負載平衡器在公用 IP 位址上公開 VM 的埠 (backendPort) 。

名稱 類型 Description
backendPort

integer

將重新導向外部流量的埠。
frontendPort

integer

輸入連線的外部埠。 可能的值範圍介於 1 到 65535 (含) 之間。 如果未指定，則會自動配置值。
transportProtocol

TransportProtocol

端點的傳輸通訊協定。

LabVirtualMachine

虛擬機器。

名稱 類型 預設值 Description
id

string

資源的標識碼。
location

string

資源的位置。
name

string

資源名稱。
properties.allowClaim

boolean

False

指出其他使用者是否可以取得虛擬機的擁有權
properties.applicableSchedule

ApplicableSchedule

虛擬機適用的排程。
properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

虛擬機的成品部署狀態。
properties.artifacts

ArtifactInstallProperties[]

要安裝在虛擬機上的成品。
properties.computeId

string

虛擬機的資源標識碼 (Microsoft.Compute) 。
properties.computeVm

ComputeVmProperties

計算虛擬機屬性。
properties.createdByUser

string

虛擬機建立者的電子郵件位址。
properties.createdByUserId

string

虛擬機建立者的物件標識碼。
properties.createdDate

string

虛擬機的建立日期。
properties.customImageId

string

虛擬機的自定義映像標識碼。
properties.dataDiskParameters

DataDiskProperties[]

建立之後要連結至虛擬機的新或現有數據磁碟
properties.disallowPublicIpAddress

boolean

False

指出是否要在不使用公用IP位址的情況下建立虛擬機。
properties.environmentId

string

包含此虛擬機的環境資源識別碼，如果有的話。
properties.expirationDate

string

VM 的到期日。
properties.fqdn

string

虛擬機的完整功能變數名稱。
properties.galleryImageReference

GalleryImageReference

虛擬機的 Microsoft Azure Marketplace 映像參考。
properties.isAuthenticationWithSshKey

boolean

指出此虛擬機是否使用 SSH 金鑰進行驗證。
properties.labSubnetName

string

虛擬機的實驗室子網名稱。
properties.labVirtualNetworkId

string

虛擬機的實驗室虛擬網路標識碼。
properties.lastKnownPowerState

string

在 DTL 中擷取的最後一個已知計算電源狀態
properties.networkInterface

NetworkInterfaceProperties

網路介面屬性。
properties.notes

string

虛擬機的附注。
properties.osType

string

虛擬機的OS類型。
properties.ownerObjectId

string

dynamicValue

虛擬機擁有者的物件標識碼。
properties.ownerUserPrincipalName

string

虛擬機擁有者的用戶主體名稱。
properties.password

string

虛擬機器系統管理員的密碼。
properties.planId

string

與虛擬機映像相關聯的計劃標識碼
properties.provisioningState

string

資源的布建狀態。
properties.scheduleParameters

ScheduleCreationParameter[]

要建立的虛擬機排程
properties.size

string

虛擬機器的大小。
properties.sshKey

string

虛擬機器系統管理員的 SSH 金鑰。
properties.storageType

string

labStorageType

要用於虛擬機 (的記憶體類型，也就是標準、進階) 。
properties.uniqueIdentifier

string

資源的唯一不可變標識碼 (Guid) 。
properties.userName

string

虛擬機的用戶名稱。
properties.virtualMachineCreationSource

VirtualMachineCreationSource

告知實驗室虛擬機的建立來源。 僅限輸出屬性。
tags

object

資源的標記。
type

string

資源類型。

LabVirtualMachineList

清單作業的回應。

名稱 類型 Description
nextLink

string

下一組結果的連結。
value

LabVirtualMachine[]

清單作業的結果。

NetworkInterfaceProperties

網路介面的屬性。

名稱 類型 Description
dnsName

string

DNS 名稱。
privateIpAddress

string

私人IP位址。
publicIpAddress

string

公用 IP 位址。
publicIpAddressId

string

公用IP位址的資源識別碼。
rdpAuthority

string

RdpAuthority 屬性是伺服器 DNS 主機名或IP位址，後面接著 RDP (遠端桌面通訊協定的服務埠號碼) 。
sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

跨多部虛擬機共用公用IP位址的組態。
sshAuthority

string

SshAuthority 屬性是伺服器 DNS 主機名或IP位址，後面接著 SSH 的服務埠號碼。
subnetId

string

子網路的資源標識碼。
virtualNetworkId

string

虛擬網路的資源識別碼。

NotificationSettings

排程的通知設定。

名稱 類型 預設值 Description
emailRecipient

string

傳送通知給 (的電子郵件收件者可以是分號分隔的電子郵件位址清單，) 。
notificationLocale

string

針對不支援的語言傳送通知 (後援時，要使用的地區設定為 EN) 。
status

EnableStatus

Disabled

如果此排程已啟用通知， (即已啟用、已停用) 。
timeInMinutes

integer

在事件傳送通知之前，以分鐘為單位的時間。
webhookUrl

string

將傳送通知的 Webhook URL。

Schedule

排程。

名稱 類型 預設值 Description
id

string

資源的標識碼。
location

string

資源的位置。
name

string

資源名稱。
properties.createdDate

string

排程的建立日期。
properties.dailyRecurrence

DayDetails

如果排程會在一周的每一天發生一次，請指定每日週期。
properties.hourlyRecurrence

HourDetails

如果排程會在一天多次發生，請指定每小時週期。
properties.notificationSettings

NotificationSettings

通知設定。
properties.provisioningState

string

資源的布建狀態。
properties.status

EnableStatus

Disabled

排程 (的狀態，也就是 [已啟用]、[已停用])

properties.targetResourceId

string

排程所屬的資源標識碼
properties.taskType

string

排程的工作類型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。
properties.timeZoneId

string

時區標識碼 (例如中國標準時間、Greenland 標準時間、太平洋標準時間等 ) 。 您可以在 () https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md 中找到IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds此屬性的可能值
properties.uniqueIdentifier

string

資源的唯一不可變標識碼 (Guid) 。
properties.weeklyRecurrence

WeekDetails

如果排程只會在星期幾發生，請指定每周週期。
tags

object

資源的標記。
type

string

資源類型。

ScheduleCreationParameter

用於建立排程的屬性。

名稱 類型 預設值 Description
location

string

新虛擬機或環境的位置
name

string

虛擬機或環境的名稱
properties.dailyRecurrence

DayDetails

如果排程會在一周的每一天發生一次，請指定每日週期。
properties.hourlyRecurrence

HourDetails

如果排程會在一天多次發生，請指定每小時週期。
properties.notificationSettings

NotificationSettings

通知設定。
properties.status

EnableStatus

Disabled

排程 (的狀態，也就是 [已啟用]、[已停用])

properties.targetResourceId

string

排程所屬的資源標識碼
properties.taskType

string

排程的工作類型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。
properties.timeZoneId

string

時區標識碼 (例如中國標準時間、Greenland 標準時間、太平洋標準時間等 ) 。 您可以在 () https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md 中找到IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds此屬性的可能值
properties.weeklyRecurrence

WeekDetails

如果排程只會在星期幾發生，請指定每周週期。
tags

object

資源的標記。

SharedPublicIpAddressConfiguration

決定其如何連線至負載平衡器的虛擬機屬性。

名稱 類型 Description
inboundNatRules

InboundNatRule[]

傳入 NAT 規則

StorageType

磁碟 (的記憶體類型，也就是標準、進階) 。

名稱 類型 Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

端點的傳輸通訊協定。

名稱 類型 Description
Tcp

string

Udp

string

VirtualMachineCreationSource

告知實驗室虛擬機的建立來源。 僅限輸出屬性。

名稱 類型 Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

每周排程的屬性。

名稱 類型 Description
time

string

排程將發生的一天時間。
weekdays

string[]

排程設定的星期幾 (例如星期日、星期一、星期二等 ) 。