Virtual Machines - List By Lab

Service:

Lab Services

API Version:

2023-06-07

Dapatkan semua komputer virtual untuk lab.
Mengembalikan daftar semua komputer virtual untuk lab.

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
labName	path	True	string	Nama lab yang secara unik mengidentifikasinya dalam rencana lab. Digunakan dalam URI sumber daya.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
$filter	query		string	Filter yang akan diterapkan ke operasi.

Respons

Nama	Jenis	Deskripsi
200 OK	PagedVirtualMachines	Permintaan berhasil; respons berisi semua komputer virtual untuk lab yang diberikan.
Other Status Codes	ErrorResponse	Respons kesalahan default.

Contoh

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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
PagedVirtualMachines	Daftar halaman komputer virtual layanan lab.
ProvisioningState	Status penyediaan komputer virtual saat ini.
ResourceOperationError	Detail kesalahan kegagalan operasi terbaru pada sumber daya ini
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
VirtualMachine	Sumber daya komputer virtual lab.
VirtualMachineConnectionProfile	Informasi koneksi untuk komputer virtual
VirtualMachineState	Status komputer virtual.
VirtualMachineType	Jenis komputer virtual lab.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

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

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

PagedVirtualMachines

Daftar halaman komputer virtual layanan lab.

Nama	Jenis	Deskripsi
nextLink	string	Tautan untuk mendapatkan halaman berikutnya dari hasil komputer virtual.
value	VirtualMachine[]	Halaman array hasil komputer virtual.

ProvisioningState

Status penyediaan komputer virtual saat ini.

Nama	Jenis	Deskripsi
Creating	string	Sumber daya sedang dalam proses dibuat.
Deleting	string	Sumber daya sedang dalam proses dihapus.
Failed	string	Operasi sebelumnya pada sumber daya gagal meninggalkan sumber daya dalam keadaan tidak sehat.
Locked	string	Sumber daya terkunci dan perubahan saat ini diblokir. Ini bisa disebabkan oleh pemeliharaan atau operasi terjadwal. Status akan kembali ke berhasil setelah operasi penguncian selesai.
Succeeded	string	Sumber daya dalam keadaan sehat setelah operasi pembuatan atau pembaruan.
Updating	string	Nilai properti baru sedang diterapkan ke sumber daya.

ResourceOperationError

Detail kesalahan kegagalan operasi terbaru pada sumber daya ini

Nama	Jenis	Deskripsi
action	string	Tindakan operasi yang gagal
code	string	Kode yang sesuai dengan jenis kegagalan operasi
message	string	Pesan kegagalan operasi
timestamp	string	Tanggalwaktu ketika kesalahan terjadi

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

VirtualMachine

Sumber daya komputer virtual lab.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.claimedByUserId	string	ID pengguna lab (bukan PUID!) dari siapa yang mengklaim komputer virtual.
properties.connectionProfile	VirtualMachineConnectionProfile	Profil untuk informasi tentang menyambungkan ke komputer virtual.
properties.provisioningState	ProvisioningState	Status penyediaan komputer virtual saat ini.
properties.resourceOperationError	ResourceOperationError	Detail kesalahan operasi terakhir yang dilakukan pada rencana lab.
properties.state	VirtualMachineState	Status komputer virtual saat ini
properties.vmType	VirtualMachineType	Jenis sumber daya VM ini
systemData	systemData	Data sistem komputer virtual Lab.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Informasi koneksi untuk komputer virtual

Nama	Jenis	Deskripsi
adminUsername	string	Nama pengguna yang digunakan untuk masuk ke komputer virtual sebagai admin.
nonAdminUsername	string	Nama pengguna yang digunakan untuk masuk ke komputer virtual sebagai non-admin, jika ada.
privateIpAddress	string	Alamat IP privat komputer virtual.
rdpAuthority	string	Nama port dan host dipisahkan oleh titik koma untuk menyambungkan melalui protokol RDP ke komputer virtual.
rdpInBrowserUrl	string	URL untuk menyambungkan melalui protokol RDP ke komputer virtual di browser.
sshAuthority	string	Nama port dan host dipisahkan oleh titik koma untuk menyambungkan melalui protokol SSH ke komputer virtual.
sshInBrowserUrl	string	URL untuk menyambungkan melalui protokol SSH ke komputer virtual di browser.

VirtualMachineState

Status komputer virtual.

Nama	Jenis	Deskripsi
Redeploying	string	VM sedang disebarkan ulang.
Reimaging	string	VM sedang digambar ulang.
ResettingPassword	string	Kata sandi VM sedang direset.
Running	string	VM sedang berjalan.
Starting	string	VM dimulai.
Stopped	string	VM saat ini dihentikan.
Stopping	string	VM berhenti.

VirtualMachineType

Jenis komputer virtual lab.

Nama	Jenis	Deskripsi
Template	string	VM templat
User	string	VM pengguna