Virtual Machines - List By Lab

Referenz

Dienst:: Lab Services

API-Version:: 2023-06-07

Abrufen aller virtuellen Computer für ein Lab.
Gibt eine Liste aller virtuellen Computer für ein Lab zurück.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labs, das es innerhalb des lab-Plans eindeutig identifiziert. Wird in Ressourcen-URIs verwendet.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PagedVirtualMachines	Die Anforderung war erfolgreich; response enthält alle virtuellen Computer für das angegebene Lab.
Other Status Codes	ErrorResponse	Die Standardfehlerantwort.

Beispiele

listVirtualMachine

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
PagedVirtualMachines	Ausgelagerte Liste der virtuellen Computer für Labdienste.
ProvisioningState	Aktueller Bereitstellungsstatus des virtuellen Computers.
ResourceOperationError	Fehlerdetails des letzten Vorgangsfehlers für diese Ressource
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
VirtualMachine	Eine Lab-VM-Ressource.
VirtualMachineConnectionProfile	Die Verbindungsinformationen für den virtuellen Computer
VirtualMachineState	Der Zustand eines virtuellen Computers.
VirtualMachineType	Der Typ des virtuellen Labscomputers.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PagedVirtualMachines

Ausgelagerte Liste der virtuellen Computer für Labdienste.

Name	Typ	Beschreibung
nextLink	string	Der Link zum Abrufen der nächsten Seite der Vm-Ergebnisse.
value	VirtualMachine[]	Die Arrayseite der Vm-Ergebnisse.

ProvisioningState

Aktueller Bereitstellungsstatus des virtuellen Computers.

Name	Typ	Beschreibung
Creating	string	Die Ressource wird gerade erstellt.
Deleting	string	Die Ressource wird gerade gelöscht.
Failed	string	Beim vorherigen Vorgang für die Ressource ist ein Fehler aufgetreten, der die Ressource im fehlerhaften Zustand belassen hat.
Locked	string	Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf Eine Wartung oder einen geplanten Vorgang zurückzuführen sein. Sobald der Sperrvorgang abgeschlossen ist, wird der Status wieder auf "erfolgreich" zurückverknen.
Succeeded	string	Die Ressource befindet sich nach dem Erstellungs- oder Aktualisierungsvorgang in einem fehlerfreien Zustand.
Updating	string	Neue Eigenschaftswerte werden auf die Ressource angewendet.

ResourceOperationError

Fehlerdetails des letzten Vorgangsfehlers für diese Ressource

Name	Typ	Beschreibung
action	string	Die Vorgangsaktion, bei der ein Fehler aufgetreten ist
code	string	Der Code, der dem Typ des Vorgangsfehlers entspricht
message	string	Meldung des Vorgangsfehlers
timestamp	string	Datum der Uhrzeit des Auftretens des Fehlers

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

VirtualMachine

Eine Lab-VM-Ressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.claimedByUserId	string	Die Labbenutzer-ID (nicht die PUID!) desJenigen, der den virtuellen Computer beansprucht hat.
properties.connectionProfile	VirtualMachineConnectionProfile	Profil für Informationen zum Herstellen einer Verbindung mit dem virtuellen Computer.
properties.provisioningState	ProvisioningState	Aktueller Bereitstellungsstatus des virtuellen Computers.
properties.resourceOperationError	ResourceOperationError	Fehlerdetails des letzten Vorgangs im Labplan.
properties.state	VirtualMachineState	Der aktuelle Zustand des virtuellen Computers
properties.vmType	VirtualMachineType	Der Typ dieser VM-Ressource
systemData	systemData	Systemdaten des virtuellen Lab-Computers.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Die Verbindungsinformationen für den virtuellen Computer

Name	Typ	Beschreibung
adminUsername	string	Der Benutzername, der zum Anmelden beim virtuellen Computer als Administrator verwendet wird.
nonAdminUsername	string	Der Benutzername, der zum Anmelden am virtuellen Computer als Nichtadministrator verwendet wird, sofern vorhanden.
privateIpAddress	string	Die private IP-Adresse des virtuellen Computers.
rdpAuthority	string	Port und Hostname getrennt durch Semikolon für die Verbindung über das RDP-Protokoll mit dem virtuellen Computer.
rdpInBrowserUrl	string	URL für die Verbindung über das RDP-Protokoll mit dem virtuellen Computer im Browser.
sshAuthority	string	Port und Hostname getrennt durch Semikolon für die Verbindung über das SSH-Protokoll mit dem virtuellen Computer.
sshInBrowserUrl	string	URL für die Verbindung über das SSH-Protokoll mit dem virtuellen Computer im Browser.

VirtualMachineState

Der Zustand eines virtuellen Computers.

Name	Typ	Beschreibung
Redeploying	string	Die VM wird erneut bereitgestellt.
Reimaging	string	Die VM wird neu erstellt.
ResettingPassword	string	Das VM-Kennwort wird zurückgesetzt.
Running	string	Der virtuelle Computer wird ausgeführt.
Starting	string	Die VM wird gestartet.
Stopped	string	Der virtuelle Computer ist derzeit beendet.
Stopping	string	Die VM wird beendet.

VirtualMachineType

Der Typ des virtuellen Labscomputers.

Name	Typ	Beschreibung
Template	string	Eine Vorlagen-VM
User	string	Eine Benutzer-VM

Freigeben über