Virtual Machines - List

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
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15&$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
labName
path True

string

Nama lab.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.

subscriptionId
path True

string

minLength: 1

ID langganan target.

api-version
query True

string

minLength: 1

Versi API yang digunakan untuk operasi ini.

$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

Nama Jenis Deskripsi
200 OK

LabVirtualMachineList

Operasi Azure berhasil diselesaikan.

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

VirtualMachines_List

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
ApplicableSchedule

Menjadwalkan 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.

ComputeDataDisk

Disk data yang terpasang pada komputer virtual.

ComputeVmInstanceViewStatus

Informasi status tentang komputer virtual.

ComputeVmProperties

Properti komputer virtual yang dikembalikan oleh MICROSOFT.Compute API.

createdByType

Jenis identitas yang membuat sumber daya.

DataDiskProperties

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

DayDetails

Properti jadwal harian.

EnableStatus

Menunjukkan apakah sumber artefak diaktifkan (nilai: Diaktifkan, Dinonaktifkan).

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Tanggapan kesalahan

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

Komputer 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 tersebut terhubung ke load balancer.

StorageType

Jenis penyimpanan untuk disk (yaitu Standar, Premium).

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

TransportProtocol

Protokol transportasi untuk titik akhir.

VirtualMachineCreationSource

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

WeekDetails

Properti jadwal mingguan.

ApplicableSchedule

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

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Lokasi sumber daya.

name

string

Nama sumber daya

properties.labVmsShutdown

Schedule

Jadwal matikan otomatis, jika telah diatur di tingkat sumber daya lab atau lab.

properties.labVmsStartup

Schedule

Jadwal mulai otomatis, jika telah ditetapkan di tingkat sumber daya lab atau lab.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ArtifactDeploymentStatusProperties

Properti penyebaran artefak.

Nama Jenis Deskripsi
artifactsApplied

integer (int32)

Jumlah total artefak yang berhasil diterapkan.

deploymentStatus

string

Status penyebaran artefak.

totalArtifacts

integer (int32)

Jumlah total artefak yang diterapkan secara tentatif.

ArtifactInstallProperties

Properti artefak.

Nama Jenis Deskripsi
artifactId

string

Pengidentifikasi artefak.

artifactTitle

string

Judul artefak.

deploymentStatusMessage

string

Pesan status dari penyebaran.

installTime

string (date-time)

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.

Nama Jenis Deskripsi
name

string

Nama parameter artefak.

value

string

Nilai parameter artefak.

AttachNewDataDiskOptions

Properti untuk melampirkan disk baru ke Komputer Virtual.

Nama Jenis Deskripsi
diskName

string

Nama disk yang akan dilampirkan.

diskSizeGiB

integer (int32)

Ukuran disk yang akan dilampirkan dalam Gibibyte.

diskType

StorageType

Jenis penyimpanan untuk disk (yaitu Standar, Premium).

ComputeDataDisk

Disk data yang terpasang pada komputer virtual.

Nama Jenis Deskripsi
diskSizeGiB

integer (int32)

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.

Nama Jenis Deskripsi
code

string

Mendapatkan Kode status.

displayStatus

string

Mendapatkan label pendek yang dapat dilokalkan untuk status tersebut.

message

string

Mendapatkan pesan yang terkait dengan status.

ComputeVmProperties

Properti komputer virtual yang dikembalikan oleh MICROSOFT.Compute API.

Nama Jenis Deskripsi
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.

createdByType

Jenis identitas yang membuat sumber daya.

Nilai Deskripsi
User
Application
ManagedIdentity
Key

DataDiskProperties

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

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
time

string

Waktu hari jadwal akan terjadi.

EnableStatus

Menunjukkan apakah sumber artefak diaktifkan (nilai: Diaktifkan, Dinonaktifkan).

Nilai Deskripsi
Enabled
Disabled

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ErrorResponse

Tanggapan kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

GalleryImageReference

Informasi referensi untuk gambar Marketplace Azure.

Nama Jenis Deskripsi
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).

Nilai Deskripsi
None
ReadOnly
ReadWrite

HourDetails

Properti jadwal per jam.

Nama Jenis Deskripsi
minute

integer (int32)

Menit dalam satu jam jadwal akan berjalan.

InboundNatRule

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

Nama Jenis Deskripsi
backendPort

integer (int32)

Port tempat lalu lintas eksternal akan dialihkan.

frontendPort

integer (int32)

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

Komputer virtual.

Nama Jenis Nilai default Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Lokasi geografis tempat sumber daya berada

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 (date-time)

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 (date-time)

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 diambil 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[]

Virtual Machine menjadwalkan untuk dibuat

properties.size

string

Ukuran komputer virtual.

properties.sshKey

string

Kunci SSH administrator komputer virtual.

properties.storageType

string

labStorageType

Jenis penyimpanan 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.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

LabVirtualMachineList

Respons operasi daftar.

Nama Jenis Deskripsi
nextLink

string (uri)

Tautan ke halaman item berikutnya

value

LabVirtualMachine[]

Item LabVirtualMachine di halaman ini

NetworkInterfaceProperties

Properti antarmuka jaringan.

Nama Jenis Deskripsi
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.

Nama Jenis Nilai default Deskripsi
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 (int32)

Waktu dalam menit sebelum peristiwa di mana pemberitahuan akan dikirim.

webhookUrl

string

URL webhook tempat pemberitahuan akan dikirim.

Schedule

Jadwal.

Nama Jenis Nilai default Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Lokasi geografis tempat sumber daya berada

name

string

Nama sumber daya

properties.createdDate

string (date-time)

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 Tiongkok, Waktu Standar Greenland, waktu Standar Pasifik, dll.). Nilai yang mungkin untuk properti ini dapat ditemukan di IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

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.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ScheduleCreationParameter

Properti untuk membuat jadwal.

Nama Jenis Nilai default Deskripsi
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 Tiongkok, Waktu Standar Greenland, waktu Standar Pasifik, dll.). Nilai yang mungkin untuk properti ini dapat ditemukan di IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

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 tersebut terhubung ke load balancer.

Nama Jenis Deskripsi
inboundNatRules

InboundNatRule[]

Aturan NAT masuk

StorageType

Jenis penyimpanan untuk disk (yaitu Standar, Premium).

Nilai Deskripsi
Standard
Premium
StandardSSD

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string (date-time)

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string (date-time)

Stempel waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir memodifikasi sumber daya.

TransportProtocol

Protokol transportasi untuk titik akhir.

Nilai Deskripsi
Tcp
Udp

VirtualMachineCreationSource

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

Nilai Deskripsi
FromCustomImage
FromGalleryImage
FromSharedGalleryImage

WeekDetails

Properti jadwal mingguan.

Nama Jenis Deskripsi
time

string

Waktu pada hari jadwal akan terjadi.

weekdays

string[]

Hari-hari dalam seminggu di mana jadwal ditetapkan (misalnya Minggu, Senin, Selasa, dll.).