Udostępnij za pośrednictwem


Virtual Machines - List

Wyświetlanie listy maszyn wirtualnych w danym laboratorium.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
labName
path True

string

Nazwa laboratorium.

resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Identyfikator subskrypcji.

api-version
query True

string

Wersja interfejsu API klienta.

$expand
query

string

Określ zapytanie $expand. Przykład: "properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)"

$filter
query

string

Filtr do zastosowania do operacji. Przykład: "$filter=contains(name,'myName')

$orderby
query

string

Wyrażenie porządkowania wyników przy użyciu notacji OData. Przykład: "$orderby=name desc"

$top
query

integer

int32

Maksymalna liczba zasobów do zwrócenia z operacji. Przykład: "$top=10"

Odpowiedzi

Nazwa Typ Opis
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Zabezpieczenia

azure_auth

Udzielanie niejawne OAuth2

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation Uzyskiwanie dostępu do platformy Microsoft Azure

Przykłady

VirtualMachines_List

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ApplicableSchedule

Harmonogramy dotyczące maszyny wirtualnej. Harmonogramy mogły zostać zdefiniowane na maszynie wirtualnej lub na poziomie laboratorium.

ArtifactDeploymentStatusProperties

Właściwości wdrożenia artefaktu.

ArtifactInstallProperties

Właściwości artefaktu.

ArtifactParameterProperties

Właściwości parametru artefaktu.

AttachNewDataDiskOptions

Właściwości dołączania nowego dysku do maszyny wirtualnej.

CloudError

Błąd żądania REST.

CloudErrorBody

Treść błędu z żądania REST.

ComputeDataDisk

Dyski danych dołączone do maszyny wirtualnej.

ComputeVmInstanceViewStatus

Informacje o stanie maszyny wirtualnej.

ComputeVmProperties

Właściwości maszyny wirtualnej zwracane przez interfejs API Microsoft.Compute.

DataDiskProperties

Treść żądania dodania nowego lub istniejącego dysku danych do maszyny wirtualnej.

DayDetails

Właściwości harmonogramu dziennego.

EnableStatus

Stan harmonogramu (tj. Włączone, Wyłączone)

GalleryImageReference

Informacje referencyjne dotyczące obrazu Azure Marketplace.

HostCachingOptions

Opcja buforowania dysku danych (tj. Brak, ReadOnly, ReadWrite).

HourDetails

Właściwości harmonogramu godzinowego.

InboundNatRule

Reguła translatora adresów sieciowych — uwidacznianie portu maszyny wirtualnej (backendPort) na publicznym adresie IP przy użyciu modułu równoważenia obciążenia.

LabVirtualMachine

Maszyna wirtualna.

LabVirtualMachineList

Odpowiedź operacji listy.

NetworkInterfaceProperties

Właściwości interfejsu sieciowego.

NotificationSettings

Ustawienia powiadomień dla harmonogramu.

Schedule

Harmonogram.

ScheduleCreationParameter

Właściwości tworzenia harmonogramu.

SharedPublicIpAddressConfiguration

Właściwości maszyny wirtualnej, która określa, jak jest połączona z modułem równoważenia obciążenia.

StorageType

Typ magazynu dysku (tj. Standardowa, Premium).

TransportProtocol

Protokół transportu dla punktu końcowego.

VirtualMachineCreationSource

Informuje o źródle tworzenia maszyny wirtualnej laboratorium. Tylko właściwość wyjściowa.

WeekDetails

Właściwości harmonogramu tygodniowego.

ApplicableSchedule

Harmonogramy dotyczące maszyny wirtualnej. Harmonogramy mogły zostać zdefiniowane na maszynie wirtualnej lub na poziomie laboratorium.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.labVmsShutdown

Schedule

Harmonogram automatycznego zamykania, jeśli został ustawiony na poziomie zasobów laboratorium lub laboratorium.

properties.labVmsStartup

Schedule

Harmonogram automatycznego uruchamiania, jeśli został ustawiony na poziomie zasobu laboratorium lub laboratorium.

tags

object

Tagi zasobu.

type

string

Typ zasobu.

ArtifactDeploymentStatusProperties

Właściwości wdrożenia artefaktu.

Nazwa Typ Opis
artifactsApplied

integer

Łączna liczba artefaktów, które zostały pomyślnie zastosowane.

deploymentStatus

string

Stan wdrożenia artefaktu.

totalArtifacts

integer

Łączna liczba artefaktów, które zostały wstępnie zastosowane.

ArtifactInstallProperties

Właściwości artefaktu.

Nazwa Typ Opis
artifactId

string

Identyfikator artefaktu.

artifactTitle

string

Tytuł artefaktu.

deploymentStatusMessage

string

Komunikat o stanie z wdrożenia.

installTime

string

Czas rozpoczęcia instalacji artefaktu na maszynie wirtualnej.

parameters

ArtifactParameterProperties[]

Parametry artefaktu.

status

string

Stan artefaktu.

vmExtensionStatusMessage

string

Komunikat o stanie z rozszerzenia maszyny wirtualnej.

ArtifactParameterProperties

Właściwości parametru artefaktu.

Nazwa Typ Opis
name

string

Nazwa parametru artefaktu.

value

string

Wartość parametru artefaktu.

AttachNewDataDiskOptions

Właściwości dołączania nowego dysku do maszyny wirtualnej.

Nazwa Typ Opis
diskName

string

Nazwa dysku do dołączenia.

diskSizeGiB

integer

Rozmiar dysku do dołączenia w gibibajtach.

diskType

StorageType

Typ magazynu dysku (tj. Standardowa, Premium).

CloudError

Błąd żądania REST.

Nazwa Typ Opis
error

CloudErrorBody

Błąd chmury, który wystąpił

CloudErrorBody

Treść błędu z żądania REST.

Nazwa Typ Opis
code

string

Kod błędu.

details

CloudErrorBody[]

Błędy wewnętrzne.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ComputeDataDisk

Dyski danych dołączone do maszyny wirtualnej.

Nazwa Typ Opis
diskSizeGiB

integer

Pobiera rozmiar dysku danych w giB.

diskUri

string

Po utworzeniu kopii zapasowej przez obiekt blob identyfikator URI bazowego obiektu blob.

managedDiskId

string

Po utworzeniu kopii zapasowej przez dysk zarządzany jest to identyfikator zasobu dysku obliczeniowego.

name

string

Pobiera nazwę dysku danych.

ComputeVmInstanceViewStatus

Informacje o stanie maszyny wirtualnej.

Nazwa Typ Opis
code

string

Pobiera kod stanu.

displayStatus

string

Pobiera krótką lokalną etykietę stanu.

message

string

Pobiera komunikat skojarzony ze stanem.

ComputeVmProperties

Właściwości maszyny wirtualnej zwracane przez interfejs API Microsoft.Compute.

Nazwa Typ Opis
dataDiskIds

string[]

Pobiera identyfikator URI obiektów blob dysków danych dla maszyny wirtualnej.

dataDisks

ComputeDataDisk[]

Pobiera wszystkie dyski danych dołączone do maszyny wirtualnej.

networkInterfaceId

string

Pobiera identyfikator interfejsu sieciowego maszyny wirtualnej.

osDiskId

string

Pobiera identyfikator URI obiektu blob dysku systemu operacyjnego dla maszyny wirtualnej.

osType

string

Pobiera typ systemu operacyjnego maszyny wirtualnej.

statuses

ComputeVmInstanceViewStatus[]

Pobiera stany maszyny wirtualnej.

vmSize

string

Pobiera rozmiar maszyny wirtualnej.

DataDiskProperties

Treść żądania dodania nowego lub istniejącego dysku danych do maszyny wirtualnej.

Nazwa Typ Opis
attachNewDataDiskOptions

AttachNewDataDiskOptions

Określa opcje dołączania nowego dysku do maszyny wirtualnej.

existingLabDiskId

string

Określa istniejący identyfikator dysku laboratorium, który ma zostać dołączony do maszyny wirtualnej.

hostCaching

HostCachingOptions

Opcja buforowania dysku danych (tj. Brak, ReadOnly, ReadWrite).

DayDetails

Właściwości harmonogramu dziennego.

Nazwa Typ Opis
time

string

Godzina dnia, w ramach których zostanie zaplanowany harmonogram.

EnableStatus

Stan harmonogramu (tj. Włączone, Wyłączone)

Nazwa Typ Opis
Disabled

string

Enabled

string

GalleryImageReference

Informacje referencyjne dotyczące obrazu Azure Marketplace.

Nazwa Typ Opis
offer

string

Oferta obrazu galerii.

osType

string

Typ systemu operacyjnego obrazu galerii.

publisher

string

Wydawca obrazu galerii.

sku

string

Jednostka SKU obrazu galerii.

version

string

Wersja obrazu galerii.

HostCachingOptions

Opcja buforowania dysku danych (tj. Brak, ReadOnly, ReadWrite).

Nazwa Typ Opis
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Właściwości harmonogramu godzinowego.

Nazwa Typ Opis
minute

integer

Minuty godziny, w których zostanie uruchomiony harmonogram.

InboundNatRule

Reguła translatora adresów sieciowych — uwidacznianie portu maszyny wirtualnej (backendPort) na publicznym adresie IP przy użyciu modułu równoważenia obciążenia.

Nazwa Typ Opis
backendPort

integer

Port, do którego zostanie przekierowany ruch zewnętrzny.

frontendPort

integer

Zewnętrzny port punktu końcowego połączenia przychodzącego. Możliwy zakres wartości z zakresu od 1 do 65535 włącznie. Jeśli nie zostanie określona, wartość zostanie przydzielona automatycznie.

transportProtocol

TransportProtocol

Protokół transportu dla punktu końcowego.

LabVirtualMachine

Maszyna wirtualna.

Nazwa Typ Domyślna wartość Opis
id

string

Identyfikator zasobu.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.allowClaim

boolean

False

Wskazuje, czy inny użytkownik może przejąć własność maszyny wirtualnej

properties.applicableSchedule

ApplicableSchedule

Odpowiedni harmonogram dla maszyny wirtualnej.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

Stan wdrożenia artefaktu dla maszyny wirtualnej.

properties.artifacts

ArtifactInstallProperties[]

Artefakty do zainstalowania na maszynie wirtualnej.

properties.computeId

string

Identyfikator zasobu (Microsoft.Compute) maszyny wirtualnej.

properties.computeVm

ComputeVmProperties

Właściwości maszyny wirtualnej obliczeniowej.

properties.createdByUser

string

Adres e-mail twórcy maszyny wirtualnej.

properties.createdByUserId

string

Identyfikator obiektu twórcy maszyny wirtualnej.

properties.createdDate

string

Data utworzenia maszyny wirtualnej.

properties.customImageId

string

Niestandardowy identyfikator obrazu maszyny wirtualnej.

properties.dataDiskParameters

DataDiskProperties[]

Nowe lub istniejące dyski danych do dołączenia do maszyny wirtualnej po utworzeniu

properties.disallowPublicIpAddress

boolean

False

Wskazuje, czy maszyna wirtualna ma zostać utworzona bez publicznego adresu IP.

properties.environmentId

string

Identyfikator zasobu środowiska, który zawiera tę maszynę wirtualną, jeśli istnieje.

properties.expirationDate

string

Data wygaśnięcia maszyny wirtualnej.

properties.fqdn

string

W pełni kwalifikowana nazwa domeny maszyny wirtualnej.

properties.galleryImageReference

GalleryImageReference

Dokumentacja obrazu Azure Marketplace firmy Microsoft dla maszyny wirtualnej.

properties.isAuthenticationWithSshKey

boolean

Wskazuje, czy ta maszyna wirtualna używa klucza SSH do uwierzytelniania.

properties.labSubnetName

string

Nazwa podsieci laboratorium maszyny wirtualnej.

properties.labVirtualNetworkId

string

Identyfikator sieci wirtualnej laboratorium maszyny wirtualnej.

properties.lastKnownPowerState

string

Ostatni znany stan mocy obliczeniowej przechwycony w DTL

properties.networkInterface

NetworkInterfaceProperties

Właściwości interfejsu sieciowego.

properties.notes

string

Uwagi dotyczące maszyny wirtualnej.

properties.osType

string

Typ systemu operacyjnego maszyny wirtualnej.

properties.ownerObjectId

string

dynamicValue

Identyfikator obiektu właściciela maszyny wirtualnej.

properties.ownerUserPrincipalName

string

Główna nazwa użytkownika właściciela maszyny wirtualnej.

properties.password

string

Hasło administratora maszyny wirtualnej.

properties.planId

string

Identyfikator planu skojarzonego z obrazem maszyny wirtualnej

properties.provisioningState

string

Stan aprowizacji zasobu.

properties.scheduleParameters

ScheduleCreationParameter[]

Harmonogramy tworzenia maszyn wirtualnych

properties.size

string

Rozmiar maszyny wirtualnej.

properties.sshKey

string

Klucz SSH administratora maszyny wirtualnej.

properties.storageType

string

labStorageType

Typ magazynu do użycia dla maszyny wirtualnej (tj. Standardowa, Premium).

properties.uniqueIdentifier

string

Unikatowy niezmienny identyfikator zasobu (Guid).

properties.userName

string

Nazwa użytkownika maszyny wirtualnej.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Informuje o źródle tworzenia maszyny wirtualnej laboratorium. Tylko właściwość wyjściowa.

tags

object

Tagi zasobu.

type

string

Typ zasobu.

LabVirtualMachineList

Odpowiedź operacji listy.

Nazwa Typ Opis
nextLink

string

Link do następnego zestawu wyników.

value

LabVirtualMachine[]

Wyniki operacji listy.

NetworkInterfaceProperties

Właściwości interfejsu sieciowego.

Nazwa Typ Opis
dnsName

string

Nazwa DNS.

privateIpAddress

string

Prywatny adres IP.

publicIpAddress

string

Publiczny adres IP.

publicIpAddressId

string

Identyfikator zasobu publicznego adresu IP.

rdpAuthority

string

Właściwość RdpAuthority jest nazwą hosta DNS serwera lub adresem IP, po którym następuje numer portu usługi dla protokołu RDP (Remote Desktop Protocol).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Konfiguracja udostępniania publicznego adresu IP na wielu maszynach wirtualnych.

sshAuthority

string

Właściwość SshAuthority jest nazwą hosta DNS serwera lub adresem IP, po którym następuje numer portu usługi dla protokołu SSH.

subnetId

string

Identyfikator zasobu podsieci.

virtualNetworkId

string

Identyfikator zasobu sieci wirtualnej.

NotificationSettings

Ustawienia powiadomień dla harmonogramu.

Nazwa Typ Domyślna wartość Opis
emailRecipient

string

Adresat wiadomości e-mail do wysyłania powiadomień do (może to być lista adresów e-mail rozdzielonych średnikami).

notificationLocale

string

Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwa dla nieobsługiwanych języków to EN).

status

EnableStatus

Disabled

Jeśli powiadomienia są włączone dla tego harmonogramu (tj. Włączone, Wyłączone).

timeInMinutes

integer

Godzina w minutach przed zdarzeniem, w którym zostanie wysłane powiadomienie.

webhookUrl

string

Adres URL elementu webhook, do którego zostanie wysłane powiadomienie.

Schedule

Harmonogram.

Nazwa Typ Domyślna wartość Opis
id

string

Identyfikator zasobu.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.createdDate

string

Data utworzenia harmonogramu.

properties.dailyRecurrence

DayDetails

Jeśli harmonogram wystąpi raz dziennie tygodnia, określ cykl dzienny.

properties.hourlyRecurrence

HourDetails

Jeśli harmonogram wystąpi wiele razy dziennie, określ cykl godzinowy.

properties.notificationSettings

NotificationSettings

Ustawienia powiadomień.

properties.provisioningState

string

Stan aprowizacji zasobu.

properties.status

EnableStatus

Disabled

Stan harmonogramu (tj. Włączone, Wyłączone)

properties.targetResourceId

string

Identyfikator zasobu, do którego należy harmonogram

properties.taskType

string

Typ zadania harmonogramu (np. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Identyfikator strefy czasowej (np. Chiny (czas standardowy, Grenlandia (czas standardowy), Pacyfik (czas standardowy itp.). Możliwe wartości tej właściwości można znaleźć w pliku IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Unikatowy niezmienny identyfikator zasobu (Guid).

properties.weeklyRecurrence

WeekDetails

Jeśli harmonogram będzie występował tylko kilka dni tygodnia, określ cykl tygodniowy.

tags

object

Tagi zasobu.

type

string

Typ zasobu.

ScheduleCreationParameter

Właściwości tworzenia harmonogramu.

Nazwa Typ Domyślna wartość Opis
location

string

Lokalizacja nowej maszyny wirtualnej lub środowiska

name

string

Nazwa maszyny wirtualnej lub środowiska

properties.dailyRecurrence

DayDetails

Jeśli harmonogram wystąpi raz dziennie tygodnia, określ cykl dzienny.

properties.hourlyRecurrence

HourDetails

Jeśli harmonogram wystąpi wiele razy dziennie, określ cykl godzinowy.

properties.notificationSettings

NotificationSettings

Ustawienia powiadomień.

properties.status

EnableStatus

Disabled

Stan harmonogramu (tj. Włączone, Wyłączone)

properties.targetResourceId

string

Identyfikator zasobu, do którego należy harmonogram

properties.taskType

string

Typ zadania harmonogramu (np. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Identyfikator strefy czasowej (np. Chiny (czas standardowy, Grenlandia (czas standardowy), Pacyfik (czas standardowy itp.). Możliwe wartości tej właściwości można znaleźć w pliku IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Jeśli harmonogram będzie występował tylko kilka dni tygodnia, określ cykl tygodniowy.

tags

object

Tagi zasobu.

SharedPublicIpAddressConfiguration

Właściwości maszyny wirtualnej, która określa, jak jest połączona z modułem równoważenia obciążenia.

Nazwa Typ Opis
inboundNatRules

InboundNatRule[]

Reguły translatora adresów sieciowych przychodzących

StorageType

Typ magazynu dysku (tj. Standardowa, Premium).

Nazwa Typ Opis
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Protokół transportu dla punktu końcowego.

Nazwa Typ Opis
Tcp

string

Udp

string

VirtualMachineCreationSource

Informuje o źródle tworzenia maszyny wirtualnej laboratorium. Tylko właściwość wyjściowa.

Nazwa Typ Opis
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Właściwości harmonogramu tygodniowego.

Nazwa Typ Opis
time

string

Godzina dnia, w ramach których zostanie zaplanowany harmonogram.

weekdays

string[]

Dni tygodnia, dla których harmonogram jest ustawiony (np. niedziela, poniedziałek, wtorek itp.).