Environments - Get

Dienst:

Lab Services

API-Version:

2018-10-15

Abrufen von Umgebungen

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}?api-version=2018-10-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}?$expand={$expand}&api-version=2018-10-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentName	path	True	string	Der Name der Umgebung.
environmentSettingName	path	True	string	Der Name der Umgebungseinstellung.
labAccountName	path	True	string	Der Name des Lab-Kontos.
labName	path	True	string	Der Name des Labors.
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=networkInterface)"

Antworten

Name	Typ	Beschreibung
200 OK	Environment	OKAY
Other Status Codes	CloudError	Ungültige Anfrage

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	Zugreifen auf Microsoft Azure

Definitionen

Name	Beschreibung
CloudError	Fehler aus einer REST-Anforderung.
CloudErrorBody	Textkörper eines Fehlers aus einer REST-Anforderung.
Environment	Stellt eine Umgebungsinstanz dar.
LatestOperationResult	Details zum Status eines Vorgangs.
NetworkInterface	Netzwerkdetails der Umgebung
ResourceSet	Stellt einen virtuellen Computer und die Einstellungs-ID dar, für die sie erstellt wurde.

CloudError

Objekt

Fehler aus einer REST-Anforderung.

Name	Typ	Beschreibung
error	CloudErrorBody	Textkörper eines Fehlers aus einer REST-Anforderung.

CloudErrorBody

Objekt

Textkörper eines Fehlers aus einer REST-Anforderung.

Name	Typ	Beschreibung
code	string
details	CloudErrorBody[]	Innere Fehler.
message	string
target	string

Environment

Objekt

Stellt eine Umgebungsinstanz dar.

Name	Typ	Beschreibung
id	string	Der Bezeichner der Ressource.
location	string	Der Standort der Ressource.
name	string	Der Name der Ressource.
properties.claimedByUserName	string	Der Name oder die E-Mail-Adresse des Benutzers, der die Umgebung beansprucht hat
properties.claimedByUserObjectId	string	Die AAD-Objekt-ID des Benutzers, der die Umgebung beansprucht hat
properties.claimedByUserPrincipalId	string	Die Benutzerprinzipal-ID des Benutzers, der die Umgebung beansprucht hat
properties.isClaimed	boolean	Wird die Umgebung beansprucht oder nicht
properties.lastKnownPowerState	string	Letzter bekannter Energiezustand der Umgebung
properties.latestOperationResult	LatestOperationResult	Die Details des neuesten Vorgangs. z. B. Status, Fehler
properties.networkInterface	NetworkInterface	Netzwerkdetails der Umgebung
properties.passwordLastReset	string (date-time)	Wann das Kennwort zuletzt in der Umgebung zurückgesetzt wurde.
properties.provisioningState	string	Der Bereitstellungsstatus der Ressource.
properties.resourceSets	ResourceSet	Die Gruppe einer VM und die Einstellungs-ID, für die sie erstellt wurde
properties.totalUsage	string (duration)	Wie lange die Umgebung von einem Lab-Benutzer verwendet wurde
properties.uniqueIdentifier	string	Der eindeutige unveränderliche Bezeichner einer Ressource (GUID).
tags	object	Die Tags der Ressource.
type	string	Der Typ der Ressource.

LatestOperationResult

Objekt

Details zum Status eines Vorgangs.

Name	Typ	Beschreibung
errorCode	string	Fehlercode beim Fehler.
errorMessage	string	Die Fehlermeldung.
httpMethod	string	Der HttpMethod - PUT/POST/DELETE für den Vorgang.
operationUrl	string	Die URL, die zum Überprüfen des Status des lang ausgeführten Vorgangs verwendet werden soll
requestUri	string	Anforderungs-URI des Vorgangs.
status	string	Der aktuelle Status des Vorgangs.

NetworkInterface

Objekt

Netzwerkdetails der Umgebung

Name	Typ	Beschreibung
privateIpAddress	string	PrivateIp-Adresse der Compute-VM
rdpAuthority	string	Verbindungsinformationen für Windows
sshAuthority	string	Verbindungsinformationen für Linux
username	string	Benutzername des virtuellen Computers

ResourceSet

Objekt

Stellt einen virtuellen Computer und die Einstellungs-ID dar, für die sie erstellt wurde.

Name	Typ	Beschreibung
resourceSettingId	string	resourceSettingId für die Umgebung
vmResourceId	string	VM-Ressourcen-ID für die Umgebung