Environments - Get

Služba:

Lab Services

Verze rozhraní API:

2018-10-15

Získání prostředí

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentName	path	True	string	Název prostředí.
environmentSettingName	path	True	string	Název nastavení prostředí.
labAccountName	path	True	string	Název účtu testovacího prostředí.
labName	path	True	string	Název testovacího prostředí.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	ID předplatného.
api-version	query	True	string	Verze rozhraní API klienta.
$expand	query		string	Zadejte dotaz $expand. Příklad: properties($expand=networkInterface)

Odpovědi

Name	Typ	Description
200 OK	Environment	OK
Other Status Codes	CloudError	Špatný požadavek

Zabezpečení

azure_auth

Implicitní udělení OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Přístup k Microsoft Azure

Definice

Name	Description
CloudError	Chyba z požadavku REST
CloudErrorBody	Text chyby z požadavku REST
Environment	Představuje instanci prostředí.
LatestOperationResult	Podrobnosti o stavu operace
NetworkInterface	Podrobnosti o síti prostředí
ResourceSet	Představuje virtuální počítač a ID nastavení, pro které se vytvořilo.

CloudError

Objekt

Chyba z požadavku REST

Name	Typ	Description
error	CloudErrorBody	Text chyby z požadavku REST

CloudErrorBody

Objekt

Text chyby z požadavku REST

Name	Typ	Description
code	string
details	CloudErrorBody[]	Vnitřní chyby.
message	string
target	string

Environment

Objekt

Představuje instanci prostředí.

Name	Typ	Description
id	string	Identifikátor prostředku.
location	string	Umístění prostředku.
name	string	Název prostředku.
properties.claimedByUserName	string	Jméno nebo e-mailová adresa uživatele, který o prostředí požádal
properties.claimedByUserObjectId	string	ID objektu AAD uživatele, který požadoval prostředí
properties.claimedByUserPrincipalId	string	ID instančního objektu uživatele uživatele, který zadal prostředí
properties.isClaimed	boolean	Je prostředí deklarované nebo ne
properties.lastKnownPowerState	string	Poslední známý stav napájení prostředí
properties.latestOperationResult	LatestOperationResult	Podrobnosti o nejnovější operaci. např: stav, chyba
properties.networkInterface	NetworkInterface	Podrobnosti o síti prostředí
properties.passwordLastReset	string (date-time)	Po posledním resetování hesla v prostředí.
properties.provisioningState	string	Stav zřizování prostředku.
properties.resourceSets	ResourceSet	Sada virtuálního počítače a ID nastavení, pro které se vytvořilo
properties.totalUsage	string (duration)	Jak dlouho prostředí používá uživatel testovacího prostředí
properties.uniqueIdentifier	string	Jedinečný neměnný identifikátor prostředku (GUID).
tags	object	Značky prostředku.
type	string	Typ prostředku.

LatestOperationResult

Objekt

Podrobnosti o stavu operace

Name	Typ	Description
errorCode	string	Kód chyby při selhání
errorMessage	string	Chybová zpráva.
httpMethod	string	HttpMethod – PUT/POST/DELETE pro operaci.
operationUrl	string	Adresa URL, která se má použít ke kontrole stavu dlouhotrvající operace
requestUri	string	Vyžádejte si identifikátor URI operace.
status	string	Aktuální stav operace.

NetworkInterface

Objekt

Podrobnosti o síti prostředí

Name	Typ	Description
privateIpAddress	string	Privátní ip adresa výpočetního virtuálního počítače
rdpAuthority	string	Informace o připojení pro Windows
sshAuthority	string	Informace o připojení pro Linux
username	string	Uživatelské jméno virtuálního počítače

ResourceSet

Objekt

Představuje virtuální počítač a ID nastavení, pro které se vytvořilo.

Name	Typ	Description
resourceSettingId	string	resourceSettingId pro prostředí
vmResourceId	string	ID prostředku virtuálního počítače pro prostředí