Freigeben über


Virtual Machines - List

Auflisten virtueller Computer in einem bestimmten Lab.

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-Parameter

Name In Erforderlich Typ Beschreibung
labName
path True

string

Der Name des Labs.

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Client-API-Version.

$expand
query

string

Geben Sie die $expand-Abfrage an. Beispiel: "properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)"

$filter
query

string

Der Filter, der auf den Vorgang angewendet werden soll. Beispiel: '$filter=contains(name,'myName')

$orderby
query

string

Der Reihenfolgesausdruck für die Ergebnisse mithilfe der OData-Notation. Beispiel: '$orderby=name desc'

$top
query

integer

int32

Die maximale Anzahl von Ressourcen, die vom Vorgang zurückgegeben werden sollen. Beispiel: '$top=10'

Antworten

Name Typ Beschreibung
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Sicherheit

azure_auth

Implizite OAuth2-Gewährung

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Zugriff auf Microsoft Azure

Beispiele

VirtualMachines_List

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ApplicableSchedule

Zeitpläne, die für einen virtuellen Computer gelten. Die Zeitpläne wurden möglicherweise auf einer VM oder auf Labebene definiert.

ArtifactDeploymentStatusProperties

Eigenschaften einer Artefaktbereitstellung.

ArtifactInstallProperties

Eigenschaften eines Artefakts.

ArtifactParameterProperties

Eigenschaften eines Artefaktparameters.

AttachNewDataDiskOptions

Eigenschaften zum Anfügen eines neuen Datenträgers an den virtuellen Computer.

CloudError

Fehler aus einer REST-Anforderung.

CloudErrorBody

Text eines Fehlers aus einer REST-Anforderung.

ComputeDataDisk

Ein Datenträger, der an einen virtuellen Computer angefügt ist.

ComputeVmInstanceViewStatus

Statusinformationen zu einem virtuellen Computer.

ComputeVmProperties

Eigenschaften eines virtuellen Computers, die von der Microsoft.Compute-API zurückgegeben werden.

DataDiskProperties

Anforderungstext zum Hinzufügen eines neuen oder vorhandenen Datenträgers zu einem virtuellen Computer.

DayDetails

Eigenschaften eines Tageszeitplans.

EnableStatus

Die status des Zeitplans (d. h. aktiviert, deaktiviert)

GalleryImageReference

Die Referenzinformationen für ein Azure Marketplace Bild.

HostCachingOptions

Zwischenspeicherungsoption für einen Datenträger (d. h. None, ReadOnly, ReadWrite).

HourDetails

Eigenschaften eines Stundenplans.

InboundNatRule

Eine Regel für NAT: Verfügbarmachen des Ports einer VM (back-EndPort) für die öffentliche IP-Adresse mithilfe eines Lastenausgleichs.

LabVirtualMachine

Einen virtuellen Computer.

LabVirtualMachineList

Die Antwort eines Listenvorgangs.

NetworkInterfaceProperties

Eigenschaften einer Netzwerkschnittstelle.

NotificationSettings

Benachrichtigungseinstellungen für einen Zeitplan.

Schedule

Ein Zeitplan.

ScheduleCreationParameter

Eigenschaften zum Erstellen eines Zeitplans.

SharedPublicIpAddressConfiguration

Eigenschaften eines virtuellen Computers, die bestimmen, wie er mit einem Lastenausgleich verbunden ist.

StorageType

Der Speichertyp für den Datenträger (d. h. Standard, Premium).

TransportProtocol

Das Transportprotokoll für den Endpunkt.

VirtualMachineCreationSource

Gibt die Quelle der Erstellung des virtuellen Labcomputers an. Nur Ausgabeeigenschaft.

WeekDetails

Eigenschaften eines Wochenplans.

ApplicableSchedule

Zeitpläne, die für einen virtuellen Computer gelten. Die Zeitpläne wurden möglicherweise auf einer VM oder auf Labebene definiert.

Name Typ Beschreibung
id

string

Der Bezeichner der Ressource.

location

string

Der Speicherort der Ressource.

name

string

Der Name der Ressource.

properties.labVmsShutdown

Schedule

Der Zeitplan für das automatische Herunterfahren, wenn einer auf Lab- oder Labressourcenebene festgelegt wurde.

properties.labVmsStartup

Schedule

Der Zeitplan für den automatischen Start, wenn einer auf Lab- oder Labressourcenebene festgelegt wurde.

tags

object

Die Tags der Ressource.

type

string

Der Typ der Ressource.

ArtifactDeploymentStatusProperties

Eigenschaften einer Artefaktbereitstellung.

Name Typ Beschreibung
artifactsApplied

integer

Die Gesamtanzahl der Artefakte, die erfolgreich angewendet wurden.

deploymentStatus

string

Die Bereitstellung status des Artefakts.

totalArtifacts

integer

Die Gesamtzahl der Artefakte, die vorläufig angewendet wurden.

ArtifactInstallProperties

Eigenschaften eines Artefakts.

Name Typ Beschreibung
artifactId

string

Der Bezeichner des Artefakts.

artifactTitle

string

Titel des Artefakts.

deploymentStatusMessage

string

Die status Meldung aus der Bereitstellung.

installTime

string

Die Zeit, zu der das Artefakt auf dem virtuellen Computer installiert wird.

parameters

ArtifactParameterProperties[]

Die Parameter des Artefakts.

status

string

Die status des Artefakts.

vmExtensionStatusMessage

string

Die status Nachricht von der VM-Erweiterung.

ArtifactParameterProperties

Eigenschaften eines Artefaktparameters.

Name Typ Beschreibung
name

string

Der Name des Artefaktparameters.

value

string

Der Wert des Artefaktparameters.

AttachNewDataDiskOptions

Eigenschaften zum Anfügen eines neuen Datenträgers an den virtuellen Computer.

Name Typ Beschreibung
diskName

string

Der Name des anzufügenden Datenträgers.

diskSizeGiB

integer

Größe des Datenträgers, der angefügt werden soll, in Gibibytes.

diskType

StorageType

Der Speichertyp für den Datenträger (d. h. Standard, Premium).

CloudError

Fehler aus einer REST-Anforderung.

Name Typ Beschreibung
error

CloudErrorBody

Der aufgetretene Cloudfehler

CloudErrorBody

Text eines Fehlers aus einer REST-Anforderung.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

CloudErrorBody[]

Innere Fehler.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ComputeDataDisk

Ein Datenträger, der an einen virtuellen Computer angefügt ist.

Name Typ Beschreibung
diskSizeGiB

integer

Ruft die Datenträgergröße in GiB ab.

diskUri

string

Bei Unterstützung durch ein Blob ist der URI des zugrunde liegenden Blobs.

managedDiskId

string

Wenn dies von einem verwalteten Datenträger unterstützt wird, ist dies die ID der Computedatenträgerressource.

name

string

Ruft den Namen des Datenträgers ab.

ComputeVmInstanceViewStatus

Statusinformationen zu einem virtuellen Computer.

Name Typ Beschreibung
code

string

Ruft den status Code ab.

displayStatus

string

Ruft die kurze lokalisierbare Bezeichnung für die status ab.

message

string

Ruft die der status zugeordnete Nachricht ab.

ComputeVmProperties

Eigenschaften eines virtuellen Computers, die von der Microsoft.Compute-API zurückgegeben werden.

Name Typ Beschreibung
dataDiskIds

string[]

Ruft Datenträger-Blob-URI für den virtuellen Computer ab.

dataDisks

ComputeDataDisk[]

Ruft alle Datenträger ab, die an den virtuellen Computer angefügt sind.

networkInterfaceId

string

Ruft die Netzwerkschnittstellen-ID des virtuellen Computers ab.

osDiskId

string

Ruft betriebssystemdatenträger-Blob-URI für den virtuellen Computer ab.

osType

string

Ruft den Betriebssystemtyp des virtuellen Computers ab.

statuses

ComputeVmInstanceViewStatus[]

Ruft die Status des virtuellen Computers ab.

vmSize

string

Ruft die Größe des virtuellen Computers ab.

DataDiskProperties

Anforderungstext zum Hinzufügen eines neuen oder vorhandenen Datenträgers zu einem virtuellen Computer.

Name Typ Beschreibung
attachNewDataDiskOptions

AttachNewDataDiskOptions

Gibt Optionen zum Anfügen eines neuen Datenträgers an den virtuellen Computer an.

existingLabDiskId

string

Gibt die vorhandene Labdatenträger-ID an, die an einen virtuellen Computer angefügt werden soll.

hostCaching

HostCachingOptions

Zwischenspeicherungsoption für einen Datenträger (d. h. None, ReadOnly, ReadWrite).

DayDetails

Eigenschaften eines Tageszeitplans.

Name Typ Beschreibung
time

string

Die Tageszeit, zu der der Zeitplan ausgeführt wird.

EnableStatus

Die status des Zeitplans (d. h. aktiviert, deaktiviert)

Name Typ Beschreibung
Disabled

string

Enabled

string

GalleryImageReference

Die Referenzinformationen für ein Azure Marketplace Bild.

Name Typ Beschreibung
offer

string

Das Angebot des Katalogimages.

osType

string

Der Betriebssystemtyp des Katalogimages.

publisher

string

Der Herausgeber des Katalogimages.

sku

string

Die SKU des Katalogimages.

version

string

Die Version des Katalogimages.

HostCachingOptions

Zwischenspeicherungsoption für einen Datenträger (d. h. None, ReadOnly, ReadWrite).

Name Typ Beschreibung
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Eigenschaften eines Stundenplans.

Name Typ Beschreibung
minute

integer

Minuten der Stunde, die der Zeitplan ausgeführt wird.

InboundNatRule

Eine Regel für NAT: Verfügbarmachen des Ports einer VM (back-EndPort) für die öffentliche IP-Adresse mithilfe eines Lastenausgleichs.

Name Typ Beschreibung
backendPort

integer

Der Port, an den der externe Datenverkehr umgeleitet wird.

frontendPort

integer

Der externe Endpunktport der eingehenden Verbindung. Mögliche Werte liegen zwischen 1 und 65.535 (einschließlich). Wenn nicht angegeben, wird ein Wert automatisch zugeordnet.

transportProtocol

TransportProtocol

Das Transportprotokoll für den Endpunkt.

LabVirtualMachine

Einen virtuellen Computer.

Name Typ Standardwert Beschreibung
id

string

Der Bezeichner der Ressource.

location

string

Der Speicherort der Ressource.

name

string

Der Name der Ressource.

properties.allowClaim

boolean

False

Gibt an, ob ein anderer Benutzer den Besitz des virtuellen Computers übernehmen kann.

properties.applicableSchedule

ApplicableSchedule

Der anwendbare Zeitplan für den virtuellen Computer.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

Die Artefaktbereitstellung status für den virtuellen Computer.

properties.artifacts

ArtifactInstallProperties[]

Die Artefakte, die auf dem virtuellen Computer installiert werden sollen.

properties.computeId

string

Der Ressourcenbezeichner (Microsoft.Compute) des virtuellen Computers.

properties.computeVm

ComputeVmProperties

Die Eigenschaften des virtuellen Computecomputers.

properties.createdByUser

string

Die E-Mail-Adresse des Erstellers des virtuellen Computers.

properties.createdByUserId

string

Der Objektbezeichner des Erstellers des virtuellen Computers.

properties.createdDate

string

Das Erstellungsdatum des virtuellen Computers.

properties.customImageId

string

Der benutzerdefinierte Imagebezeichner des virtuellen Computers.

properties.dataDiskParameters

DataDiskProperties[]

Neue oder vorhandene Datenträger, die nach der Erstellung an den virtuellen Computer angefügt werden sollen

properties.disallowPublicIpAddress

boolean

False

Gibt an, ob der virtuelle Computer ohne öffentliche IP-Adresse erstellt werden soll.

properties.environmentId

string

Die Ressourcen-ID der Umgebung, die diesen virtuellen Computer enthält, falls vorhanden.

properties.expirationDate

string

Das Ablaufdatum für den virtuellen Computer.

properties.fqdn

string

Der vollqualifizierte Domänenname des virtuellen Computers.

properties.galleryImageReference

GalleryImageReference

Die Microsoft Azure Marketplace Imagereferenz des virtuellen Computers.

properties.isAuthenticationWithSshKey

boolean

Gibt an, ob dieser virtuelle Computer einen SSH-Schlüssel für die Authentifizierung verwendet.

properties.labSubnetName

string

Der Lab-Subnetzname des virtuellen Computers.

properties.labVirtualNetworkId

string

Der Lab-Bezeichner des virtuellen Netzwerks des virtuellen Computers.

properties.lastKnownPowerState

string

Letzter bekannter Computeleistungsstatus, der in DTL erfasst wurde

properties.networkInterface

NetworkInterfaceProperties

Die Netzwerkschnittstelleneigenschaften.

properties.notes

string

Die Notizen des virtuellen Computers.

properties.osType

string

Der Betriebssystemtyp des virtuellen Computers.

properties.ownerObjectId

string

dynamicValue

Der Objektbezeichner des Besitzers des virtuellen Computers.

properties.ownerUserPrincipalName

string

Der Benutzerprinzipalname des Besitzers des virtuellen Computers.

properties.password

string

Das Kennwort des VM-Administrators.

properties.planId

string

Die ID des Plans, der dem VM-Image zugeordnet ist

properties.provisioningState

string

Der Bereitstellungs-status der Ressource.

properties.scheduleParameters

ScheduleCreationParameter[]

Zu erstellende VM-Zeitpläne

properties.size

string

Die Größe des virtuellen Computers.

properties.sshKey

string

Der SSH-Schlüssel des VM-Administrators.

properties.storageType

string

labStorageType

Speichertyp, der für virtuelle Computer verwendet werden soll (d. h. Standard, Premium).

properties.uniqueIdentifier

string

Der eindeutige unveränderliche Bezeichner einer Ressource (Guid).

properties.userName

string

Der Benutzername des virtuellen Computers.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Gibt die Quelle der Erstellung des virtuellen Labcomputers an. Nur Ausgabeeigenschaft.

tags

object

Die Tags der Ressource.

type

string

Der Typ der Ressource.

LabVirtualMachineList

Die Antwort eines Listenvorgangs.

Name Typ Beschreibung
nextLink

string

Link für den nächsten Satz von Ergebnissen.

value

LabVirtualMachine[]

Ergebnisse des Listenvorgangs.

NetworkInterfaceProperties

Eigenschaften einer Netzwerkschnittstelle.

Name Typ Beschreibung
dnsName

string

Der DNS-Name.

privateIpAddress

string

Die private IP-Adresse.

publicIpAddress

string

Öffentliche IP-Adresse

publicIpAddressId

string

Die Ressourcen-ID der öffentlichen IP-Adresse.

rdpAuthority

string

Die RdpAuthority-Eigenschaft ist ein SERVER-DNS-Hostname oder eine IP-Adresse, gefolgt von der Dienstportnummer für RDP (Remotedesktopprotokoll).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Die Konfiguration zum Freigeben einer öffentlichen IP-Adresse über mehrere virtuelle Computer hinweg.

sshAuthority

string

Die SshAuthority-Eigenschaft ist ein DNS-Hostname oder eine IP-Adresse des Servers, gefolgt von der Dienstportnummer für SSH.

subnetId

string

Die Ressourcen-ID des Subnetzes.

virtualNetworkId

string

Die Ressourcen-ID des virtuellen Netzwerks.

NotificationSettings

Benachrichtigungseinstellungen für einen Zeitplan.

Name Typ Standardwert Beschreibung
emailRecipient

string

Der E-Mail-Empfänger, an den Benachrichtigungen gesendet werden sollen (kann eine Liste von durch Semikolon getrennten E-Mail-Adressen sein).

notificationLocale

string

Das Gebietsschema, das beim Senden einer Benachrichtigung verwendet werden soll (Fallback für nicht unterstützte Sprachen ist EN).

status

EnableStatus

Disabled

Wenn Benachrichtigungen für diesen Zeitplan aktiviert sind (d. h. Aktiviert, Deaktiviert).

timeInMinutes

integer

Zeit in Minuten vor dem Ereignis, zu dem die Benachrichtigung gesendet wird.

webhookUrl

string

Die Webhook-URL, an die die Benachrichtigung gesendet wird.

Schedule

Ein Zeitplan.

Name Typ Standardwert Beschreibung
id

string

Der Bezeichner der Ressource.

location

string

Der Speicherort der Ressource.

name

string

Der Name der Ressource.

properties.createdDate

string

Das Erstellungsdatum des Zeitplans.

properties.dailyRecurrence

DayDetails

Wenn der Zeitplan einmal pro Wochentag auftritt, geben Sie die tägliche Wiederholung an.

properties.hourlyRecurrence

HourDetails

Wenn der Zeitplan mehrmals täglich auftritt, geben Sie die stündliche Wiederholung an.

properties.notificationSettings

NotificationSettings

Benachrichtigungseinstellungen.

properties.provisioningState

string

Der Bereitstellungs-status der Ressource.

properties.status

EnableStatus

Disabled

Die status des Zeitplans (d. h. aktiviert, deaktiviert)

properties.targetResourceId

string

Die Ressourcen-ID, zu der der Zeitplan gehört

properties.taskType

string

Der Aufgabentyp des Zeitplans (z. B. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Die Zeitzonen-ID (z. B. China Standardzeit, Grönland Standardzeit, Pazifische Standardzeit usw.). Die möglichen Werte für diese Eigenschaft finden Sie in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Der eindeutige unveränderliche Bezeichner einer Ressource (Guid).

properties.weeklyRecurrence

WeekDetails

Wenn der Zeitplan nur an einigen Tagen der Woche auftritt, geben Sie die wöchentliche Wiederholung an.

tags

object

Die Tags der Ressource.

type

string

Der Typ der Ressource.

ScheduleCreationParameter

Eigenschaften zum Erstellen eines Zeitplans.

Name Typ Standardwert Beschreibung
location

string

Der Speicherort des neuen virtuellen Computers oder der neuen Umgebung

name

string

Der Name des virtuellen Computers oder der Umgebung

properties.dailyRecurrence

DayDetails

Wenn der Zeitplan einmal pro Wochentag auftritt, geben Sie die tägliche Wiederholung an.

properties.hourlyRecurrence

HourDetails

Wenn der Zeitplan mehrmals täglich auftritt, geben Sie die stündliche Wiederholung an.

properties.notificationSettings

NotificationSettings

Benachrichtigungseinstellungen.

properties.status

EnableStatus

Disabled

Die status des Zeitplans (d. h. aktiviert, deaktiviert)

properties.targetResourceId

string

Die Ressourcen-ID, zu der der Zeitplan gehört

properties.taskType

string

Der Aufgabentyp des Zeitplans (z. B. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Die Zeitzonen-ID (z. B. China Standardzeit, Grönland Standardzeit, Pazifische Standardzeit usw.). Die möglichen Werte für diese Eigenschaft finden Sie in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Wenn der Zeitplan nur an einigen Tagen der Woche auftritt, geben Sie die wöchentliche Wiederholung an.

tags

object

Die Tags der Ressource.

SharedPublicIpAddressConfiguration

Eigenschaften eines virtuellen Computers, die bestimmen, wie er mit einem Lastenausgleich verbunden ist.

Name Typ Beschreibung
inboundNatRules

InboundNatRule[]

Die eingehenden NAT-Regeln

StorageType

Der Speichertyp für den Datenträger (d. h. Standard, Premium).

Name Typ Beschreibung
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Das Transportprotokoll für den Endpunkt.

Name Typ Beschreibung
Tcp

string

Udp

string

VirtualMachineCreationSource

Gibt die Quelle der Erstellung des virtuellen Labcomputers an. Nur Ausgabeeigenschaft.

Name Typ Beschreibung
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Eigenschaften eines Wochenplans.

Name Typ Beschreibung
time

string

Die Uhrzeit des Tages, zu dem der Zeitplan auftritt.

weekdays

string[]

Die Wochentage, für die der Zeitplan festgelegt ist (z. B. Sonntag, Montag, Dienstag usw.).