Virtual Machines - List By Lab

Referenz

Dienst:: Lab Services

API-Version:: 2023-06-07

Rufen Sie alle virtuellen Computer für ein Lab ab.
Gibt eine Liste aller virtuellen Computer für ein Labor 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 minLength: 1 maxLength: 100	Der Name des Labors, das es innerhalb eines Laborplans eindeutig identifiziert. Wird in Ressourcen-URIs verwendet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PagedVirtualMachines	Die Anforderung war erfolgreich; die Antwort enthält alle virtuellen Computer für die angegebene Übung.
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	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PagedVirtualMachines	Ausgelagerte Liste der virtuellen Computer von Lab Services.
ProvisioningState	Aktueller Bereitstellungsstatus des virtuellen Computers.
ResourceOperationError	Fehlerdetails des neuesten Vorgangsfehlers für diese Ressource
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
VirtualMachine	Eine ressource für virtuelle Laborcomputer.
VirtualMachineConnectionProfile	Die Verbindungsinformationen für den virtuellen Computer
VirtualMachineState	Der Status eines virtuellen Computers.
VirtualMachineType	Der Typ des virtuellen Laborcomputers.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PagedVirtualMachines

Objekt

Ausgelagerte Liste der virtuellen Computer von Lab Services.

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

ProvisioningState

Enumeration

Aktueller Bereitstellungsstatus des virtuellen Computers.

Wert	Beschreibung
Creating	Die Ressource wird gerade erstellt.
Deleting	Die Ressource wird gelöscht.
Failed	Der vorherige Vorgang für die Ressource ist fehlgeschlagen, wenn die Ressource im fehlerhaften Zustand verlassen wurde.
Locked	Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf Wartung oder einen geplanten Betrieb zurückzuführen sein. Der Zustand wechselt zurück, um erfolgreich zu sein, nachdem der Sperrvorgang abgeschlossen ist.
Succeeded	Die Ressource befindet sich nach dem Erstellungs- oder Aktualisierungsvorgang im fehlerfreien Zustand.
Updating	Neue Eigenschaftswerte werden auf die Ressource angewendet.

ResourceOperationError

Objekt

Fehlerdetails des neuesten Vorgangsfehlers für diese Ressource

Name	Typ	Beschreibung
action	string	Die fehlgeschlagene Vorgangsaktion
code	string	Der Code, der dem Typ des Vorgangsfehlers entspricht
message	string	Fehlermeldung des Vorgangs
timestamp	string (date-time)	Datum und Uhrzeit des Auftretens des Fehlers

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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

Objekt

Eine ressource für virtuelle Laborcomputer.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.claimedByUserId	string	Die Lab-Benutzer-ID (nicht die PUID!) von wem der virtuelle Computer beansprucht wurde.
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, der im Laborplan ausgeführt wurde.
properties.state	VirtualMachineState	Der aktuelle Zustand des virtuellen Computers
properties.vmType	VirtualMachineType	Der Typ dieser VM-Ressource
systemData	systemData	Systemdaten des virtuellen Laborcomputers.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Objekt

Die Verbindungsinformationen für den virtuellen Computer

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

VirtualMachineState

Enumeration

Der Status eines virtuellen Computers.

Wert	Beschreibung
Redeploying	Der virtuelle Computer wird erneut bereitgestellt.
Reimaging	Der virtuelle Computer wird umimaged erstellt.
ResettingPassword	Das Kennwort des virtuellen Computers wird zurückgesetzt.
Running	Der virtuelle Computer wird ausgeführt.
Starting	Der virtuelle Computer wird gestartet.
Stopped	Der virtuelle Computer wird zurzeit beendet.
Stopping	Der virtuelle Computer wird beendet.

VirtualMachineType

Enumeration

Der Typ des virtuellen Laborcomputers.

Wert	Beschreibung
Template	Eine Vorlagen-VM
User	Eine Benutzer-VM

Freigeben über

Virtual Machines - List By Lab

URI-Parameter

Antworten

Beispiele

listVirtualMachine

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType

Zusätzliche Ressourcen