Virtual Machines - List

Referensi

Service:: Dev Test Labs

API Version:: 2018-09-15

Mencantumkan komputer virtual di lab tertentu.

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

With optional parameters:

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

Parameter URI

Name	In	Required	Type	Description
labName	path	True	string	Nama lab.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	ID langganan.
api-version	query	True	string	Versi API klien.
$expand	query		string	Tentukan kueri $expand. Contoh: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'
$filter	query		string	Filter yang akan diterapkan ke operasi. Contoh: '$filter=contains(name,'myName')
$orderby	query		string	Ekspresi pengurutan untuk hasil, menggunakan notasi OData. Contoh: '$orderby=name desc'
$top	query		integer int32	Jumlah maksimum sumber daya yang akan dikembalikan dari operasi. Contoh: '$top=10'

Respons

Name	Type	Description
200 OK	LabVirtualMachineList	OK
Other Status Codes	CloudError	BadRequest

Keamanan

azure_auth

Pemberian Implisit OAuth2

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

Scopes

Name	Description
user_impersonation	Microsoft Azure Akses

Contoh

VirtualMachines_List

Sample Request

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

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json
func ExampleVirtualMachinesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdevtestlabs.NewVirtualMachinesClient("{subscriptionId}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("resourceGroupName",
		"{labName}",
		&armdevtestlabs.VirtualMachinesClientListOptions{Expand: nil,
			Filter:  nil,
			Top:     nil,
			Orderby: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List virtual machines in a given lab.
 *
 * @summary List virtual machines in a given lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json
 */
async function virtualMachinesList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachines.list(resourceGroupName, labName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

virtualMachinesList().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

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

Definisi

ApplicableSchedule	Jadwal yang berlaku untuk komputer virtual. Jadwal mungkin telah ditentukan pada VM atau pada tingkat lab.
ArtifactDeploymentStatusProperties	Properti penyebaran artefak.
ArtifactInstallProperties	Properti artefak.
ArtifactParameterProperties	Properti parameter artefak.
AttachNewDataDiskOptions	Properti untuk melampirkan disk baru ke Komputer Virtual.
CloudError	Kesalahan dari permintaan REST.
CloudErrorBody	Isi kesalahan dari permintaan REST.
ComputeDataDisk	Disk data yang terpasang pada komputer virtual.
ComputeVmInstanceViewStatus	Informasi status tentang komputer virtual.
ComputeVmProperties	Properti komputer virtual yang dikembalikan oleh Microsoft.Compute API.
DataDiskProperties	Isi permintaan untuk menambahkan disk data baru atau yang sudah ada ke komputer virtual.
DayDetails	Properti jadwal harian.
EnableStatus	Status jadwal (yaitu Diaktifkan, Dinonaktifkan)
GalleryImageReference	Informasi referensi untuk gambar Marketplace Azure.
HostCachingOptions	Opsi penembolokan untuk disk data (yaitu None, ReadOnly, ReadWrite).
HourDetails	Properti jadwal per jam.
InboundNatRule	Aturan untuk NAT - mengekspos port VM (backendPort) pada alamat IP publik menggunakan load balancer.
LabVirtualMachine	Mesin virtual.
LabVirtualMachineList	Respons operasi daftar.
NetworkInterfaceProperties	Properti antarmuka jaringan.
NotificationSettings	Pengaturan pemberitahuan untuk jadwal.
Schedule	Jadwal.
ScheduleCreationParameter	Properti untuk membuat jadwal.
SharedPublicIpAddressConfiguration	Properti komputer virtual yang menentukan bagaimana komputer virtual terhubung ke penyeimbang beban.
StorageType	Jenis penyimpanan untuk disk (yaitu Standar, Premium).
TransportProtocol	Protokol transportasi untuk titik akhir.
VirtualMachineCreationSource	Memberi tahu sumber pembuatan komputer virtual lab. Properti output saja.
WeekDetails	Properti jadwal mingguan.

ApplicableSchedule

Jadwal yang berlaku untuk komputer virtual. Jadwal mungkin telah ditentukan pada VM atau pada tingkat lab.

Name	Type	Description
id	string	Pengidentifikasi sumber daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.labVmsShutdown	Schedule	Jadwal matikan otomatis, jika jadwal telah ditetapkan di tingkat sumber daya lab atau lab.
properties.labVmsStartup	Schedule	Jadwal mulai otomatis, jika telah ditetapkan di tingkat sumber daya lab atau lab.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya.

ArtifactDeploymentStatusProperties

Properti penyebaran artefak.

Name	Type	Description
artifactsApplied	integer	Jumlah total artefak yang berhasil diterapkan.
deploymentStatus	string	Status penyebaran artefak.
totalArtifacts	integer	Jumlah total artefak yang diterapkan secara tentatif.

ArtifactInstallProperties

Properti artefak.

Name	Type	Description
artifactId	string	Pengidentifikasi artefak.
artifactTitle	string	Judul artefak.
deploymentStatusMessage	string	Pesan status dari penyebaran.
installTime	string	Waktu artefak mulai diinstal pada komputer virtual.
parameters	ArtifactParameterProperties[]	Parameter artefak.
status	string	Status artefak.
vmExtensionStatusMessage	string	Pesan status dari ekstensi komputer virtual.

ArtifactParameterProperties

Properti parameter artefak.

Name	Type	Description
name	string	Nama parameter artefak.
value	string	Nilai parameter artefak.

AttachNewDataDiskOptions

Properti untuk melampirkan disk baru ke Komputer Virtual.

Name	Type	Description
diskName	string	Nama disk yang akan dilampirkan.
diskSizeGiB	integer	Ukuran disk yang akan dilampirkan dalam Gibibyte.
diskType	StorageType	Jenis penyimpanan untuk disk (yaitu Standar, Premium).

CloudError

Kesalahan dari permintaan REST.

Name	Type	Description
error	CloudErrorBody	Kesalahan cloud yang terjadi

CloudErrorBody

Isi kesalahan dari permintaan REST.

Name	Type	Description
code	string	Kode kesalahan.
details	CloudErrorBody[]	Kesalahan dalam.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ComputeDataDisk

Disk data yang terpasang pada komputer virtual.

Name	Type	Description
diskSizeGiB	integer	Mendapatkan ukuran disk data di GiB.
diskUri	string	Ketika didukung oleh blob, URI blob yang mendasar.
managedDiskId	string	Ketika didukung oleh disk terkelola, ini adalah ID sumber daya disk komputasi.
name	string	Mendapatkan nama disk data.

ComputeVmInstanceViewStatus

Informasi status tentang komputer virtual.

Name	Type	Description
code	string	Mendapatkan Kode status.
displayStatus	string	Mendapatkan label singkat yang dapat dilokalkan untuk status tersebut.
message	string	Mendapatkan pesan yang terkait dengan status.

ComputeVmProperties

Properti komputer virtual yang dikembalikan oleh Microsoft.Compute API.

Name	Type	Description
dataDiskIds	string[]	Mendapatkan uri blob disk data untuk komputer virtual.
dataDisks	ComputeDataDisk[]	Mendapatkan semua disk data yang terpasang pada komputer virtual.
networkInterfaceId	string	Mendapatkan ID antarmuka jaringan komputer virtual.
osDiskId	string	Mendapatkan uri blob disk OS untuk komputer virtual.
osType	string	Mendapatkan jenis OS komputer virtual.
statuses	ComputeVmInstanceViewStatus[]	Mendapatkan status komputer virtual.
vmSize	string	Mendapatkan ukuran komputer virtual.

DataDiskProperties

Isi permintaan untuk menambahkan disk data baru atau yang sudah ada ke komputer virtual.

Name	Type	Description
attachNewDataDiskOptions	AttachNewDataDiskOptions	Menentukan opsi untuk melampirkan disk baru ke komputer virtual.
existingLabDiskId	string	Menentukan id disk lab yang ada untuk dilampirkan ke komputer virtual.
hostCaching	HostCachingOptions	Opsi penembolokan untuk disk data (yaitu None, ReadOnly, ReadWrite).

DayDetails

Properti jadwal harian.

Name	Type	Description
time	string	Waktu pada hari jadwal akan terjadi.

EnableStatus

Status jadwal (yaitu Diaktifkan, Dinonaktifkan)

Name	Type	Description
Disabled	string
Enabled	string

GalleryImageReference

Informasi referensi untuk gambar Marketplace Azure.

Name	Type	Description
offer	string	Penawaran gambar galeri.
osType	string	Jenis OS gambar galeri.
publisher	string	Penerbit gambar galeri.
sku	string	SKU gambar galeri.
version	string	Versi gambar galeri.

HostCachingOptions

Opsi penembolokan untuk disk data (yaitu None, ReadOnly, ReadWrite).

Name	Type	Description
None	string
ReadOnly	string
ReadWrite	string

HourDetails

Properti jadwal per jam.

Name	Type	Description
minute	integer	Menit dalam satu jam jadwal akan berjalan.

InboundNatRule

Aturan untuk NAT - mengekspos port VM (backendPort) pada alamat IP publik menggunakan load balancer.

Name	Type	Description
backendPort	integer	Port tempat lalu lintas eksternal akan dialihkan.
frontendPort	integer	Port titik akhir eksternal dari koneksi masuk. Nilai yang mungkin berkisar antara 1 dan 65535, termasuk. Jika tidak ditentukan, nilai akan dialokasikan secara otomatis.
transportProtocol	TransportProtocol	Protokol transportasi untuk titik akhir.

LabVirtualMachine

Mesin virtual.

Name	Type	Default Value	Description
id	string		Pengidentifikasi sumber daya.
location	string		Lokasi sumber daya.
name	string		Nama sumber daya.
properties.allowClaim	boolean	False	Menunjukkan apakah pengguna lain dapat mengambil kepemilikan komputer virtual
properties.applicableSchedule	ApplicableSchedule		Jadwal yang berlaku untuk komputer virtual.
properties.artifactDeploymentStatus	ArtifactDeploymentStatusProperties		Status penyebaran artefak untuk komputer virtual.
properties.artifacts	ArtifactInstallProperties[]		Artefak yang akan diinstal pada komputer virtual.
properties.computeId	string		Pengidentifikasi sumber daya (Microsoft.Compute) dari komputer virtual.
properties.computeVm	ComputeVmProperties		Properti komputer virtual komputasi.
properties.createdByUser	string		Alamat email pembuat komputer virtual.
properties.createdByUserId	string		Pengidentifikasi objek pembuat komputer virtual.
properties.createdDate	string		Tanggal pembuatan komputer virtual.
properties.customImageId	string		Pengidentifikasi gambar kustom komputer virtual.
properties.dataDiskParameters	DataDiskProperties[]		Disk data baru atau yang sudah ada untuk dilampirkan ke komputer virtual setelah pembuatan
properties.disallowPublicIpAddress	boolean	False	Menunjukkan apakah komputer virtual akan dibuat tanpa alamat IP publik.
properties.environmentId	string		ID sumber daya lingkungan yang berisi komputer virtual ini, jika ada.
properties.expirationDate	string		Tanggal kedaluwarsa untuk VM.
properties.fqdn	string		Nama domain komputer virtual yang sepenuhnya memenuhi syarat.
properties.galleryImageReference	GalleryImageReference		Referensi gambar Microsoft Azure Marketplace dari komputer virtual.
properties.isAuthenticationWithSshKey	boolean		Menunjukkan apakah komputer virtual ini menggunakan kunci SSH untuk autentikasi.
properties.labSubnetName	string		Nama subnet lab komputer virtual.
properties.labVirtualNetworkId	string		Pengidentifikasi jaringan virtual lab komputer virtual.
properties.lastKnownPowerState	string		Status daya komputasi terakhir yang diketahui ditangkap di DTL
properties.networkInterface	NetworkInterfaceProperties		Properti antarmuka jaringan.
properties.notes	string		Catatan komputer virtual.
properties.osType	string		Jenis OS komputer virtual.
properties.ownerObjectId	string	dynamicValue	Pengidentifikasi objek pemilik komputer virtual.
properties.ownerUserPrincipalName	string		Nama utama pengguna pemilik komputer virtual.
properties.password	string		Kata sandi administrator komputer virtual.
properties.planId	string		Id paket yang terkait dengan gambar komputer virtual
properties.provisioningState	string		Status provisi sumber daya.
properties.scheduleParameters	ScheduleCreationParameter[]		Jadwal Komputer Virtual yang akan dibuat
properties.size	string		Ukuran komputer virtual.
properties.sshKey	string		Kunci SSH administrator komputer virtual.
properties.storageType	string	labStorageType	jenis Storage yang digunakan untuk komputer virtual (yaitu Standar, Premium).
properties.uniqueIdentifier	string		Pengidentifikasi unik yang tidak dapat diubah dari sumber daya (Guid).
properties.userName	string		Nama pengguna komputer virtual.
properties.virtualMachineCreationSource	VirtualMachineCreationSource		Memberi tahu sumber pembuatan komputer virtual lab. Properti output saja.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya.

LabVirtualMachineList

Respons operasi daftar.

Name	Type	Description
nextLink	string	Tautan untuk kumpulan hasil berikutnya.
value	LabVirtualMachine[]	Hasil operasi daftar.

NetworkInterfaceProperties

Properti antarmuka jaringan.

Name	Type	Description
dnsName	string	Nama DNS.
privateIpAddress	string	Alamat IP privat.
publicIpAddress	string	Alamat IP publik
publicIpAddressId	string	ID sumber daya alamat IP publik.
rdpAuthority	string	Properti RdpAuthority adalah nama host DNS server atau alamat IP diikuti dengan nomor port layanan untuk RDP (Protokol Desktop Jarak Jauh).
sharedPublicIpAddressConfiguration	SharedPublicIpAddressConfiguration	Konfigurasi untuk berbagi alamat IP publik di beberapa komputer virtual.
sshAuthority	string	Properti SshAuthority adalah nama host DNS server atau alamat IP diikuti dengan nomor port layanan untuk SSH.
subnetId	string	ID sumber daya sub net.
virtualNetworkId	string	ID sumber daya jaringan virtual.

NotificationSettings

Pengaturan pemberitahuan untuk jadwal.

Name	Type	Default Value	Description
emailRecipient	string		Penerima email untuk mengirim pemberitahuan ke (dapat menjadi daftar alamat email yang dipisahkan titik koma).
notificationLocale	string		Lokal yang digunakan saat mengirim pemberitahuan (fallback untuk bahasa yang tidak didukung adalah EN).
status	EnableStatus	Disabled	Jika pemberitahuan diaktifkan untuk jadwal ini (yaitu Diaktifkan, Dinonaktifkan).
timeInMinutes	integer		Waktu dalam menit sebelum peristiwa di mana pemberitahuan akan dikirim.
webhookUrl	string		URL webhook tempat pemberitahuan akan dikirim.

Schedule

Jadwal.

Name	Type	Default Value	Description
id	string		Pengidentifikasi sumber daya.
location	string		Lokasi sumber daya.
name	string		Nama sumber daya.
properties.createdDate	string		Tanggal pembuatan jadwal.
properties.dailyRecurrence	DayDetails		Jika jadwal akan terjadi sekali setiap hari dalam seminggu, tentukan pengulangan harian.
properties.hourlyRecurrence	HourDetails		Jika jadwal akan terjadi beberapa kali sehari, tentukan pengulangan per jam.
properties.notificationSettings	NotificationSettings		Pengaturan pemberitahuan.
properties.provisioningState	string		Status provisi sumber daya.
properties.status	EnableStatus	Disabled	Status jadwal (yaitu Diaktifkan, Dinonaktifkan)
properties.targetResourceId	string		ID sumber daya tempat jadwal berada
properties.taskType	string		Jenis tugas jadwal (misalnya LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		ID zona waktu (misalnya waktu Standar Pasifik).
properties.uniqueIdentifier	string		Pengidentifikasi unik yang tidak dapat diubah dari sumber daya (Guid).
properties.weeklyRecurrence	WeekDetails		Jika jadwal hanya akan terjadi beberapa hari dalam seminggu, tentukan pengulangan mingguan.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya.

ScheduleCreationParameter

Properti untuk membuat jadwal.

Name	Type	Default Value	Description
location	string		Lokasi komputer atau lingkungan virtual baru
name	string		Nama komputer atau lingkungan virtual
properties.dailyRecurrence	DayDetails		Jika jadwal akan terjadi sekali setiap hari dalam seminggu, tentukan pengulangan harian.
properties.hourlyRecurrence	HourDetails		Jika jadwal akan terjadi beberapa kali sehari, tentukan pengulangan per jam.
properties.notificationSettings	NotificationSettings		Pengaturan pemberitahuan.
properties.status	EnableStatus	Disabled	Status jadwal (yaitu Diaktifkan, Dinonaktifkan)
properties.targetResourceId	string		ID sumber daya tempat jadwal berada
properties.taskType	string		Jenis tugas jadwal (misalnya LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		ID zona waktu (misalnya waktu Standar Pasifik).
properties.weeklyRecurrence	WeekDetails		Jika jadwal hanya akan terjadi beberapa hari dalam seminggu, tentukan pengulangan mingguan.
tags	object		Tag sumber daya.

SharedPublicIpAddressConfiguration

Properti komputer virtual yang menentukan bagaimana komputer virtual terhubung ke penyeimbang beban.

Name	Type	Description
inboundNatRules	InboundNatRule[]	Aturan NAT yang masuk

StorageType

Jenis penyimpanan untuk disk (yaitu Standar, Premium).

Name	Type	Description
Premium	string
Standard	string
StandardSSD	string

TransportProtocol

Protokol transportasi untuk titik akhir.

Name	Type	Description
Tcp	string
Udp	string

VirtualMachineCreationSource

Memberi tahu sumber pembuatan komputer virtual lab. Properti output saja.

Name	Type	Description
FromCustomImage	string
FromGalleryImage	string
FromSharedGalleryImage	string

WeekDetails

Properti jadwal mingguan.

Name	Type	Description
time	string	Waktu pada hari jadwal akan terjadi.
weekdays	string[]	Hari-hari dalam seminggu di mana jadwal ditetapkan (misalnya Minggu, Senin, Selasa, dll.).