Environments - Get

Служба:

Lab Services

Версия API:

2018-10-15

Получение среды

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

С использованием необязательных параметров:

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

Имя	В	Обязательно	Тип	Описание
environmentName	path	True	string	Имя среды.
environmentSettingName	path	True	string	Имя параметра среды.
labAccountName	path	True	string	Имя учетной записи лаборатории.
labName	path	True	string	Имя лаборатории.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$expand	query		string	Укажите запрос $expand. Пример: properties($expand=networkInterface)"

Ответы

Имя	Тип	Описание
200 OK	Environment	ХОРОШО
Other Status Codes	CloudError	Неверный запрос

Безопасность

azure_auth

Неявное предоставление OAuth2

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	Доступ к Microsoft Azure

Определения

Имя	Описание
CloudError	Ошибка из запроса REST.
CloudErrorBody	Текст ошибки из запроса REST.
Environment	Представляет экземпляр среды
LatestOperationResult	Сведения о состоянии операции.
NetworkInterface	Сведения о сети среды
ResourceSet	Представляет виртуальную машину и идентификатор параметра, для который он был создан.

CloudError

Object

Ошибка из запроса REST.

Имя	Тип	Описание
error	CloudErrorBody	Текст ошибки из запроса REST.

CloudErrorBody

Object

Текст ошибки из запроса REST.

Имя	Тип	Описание
code	string
details	CloudErrorBody[]	Внутренние ошибки.
message	string
target	string

Environment

Object

Представляет экземпляр среды

Имя	Тип	Описание
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.claimedByUserName	string	Имя или адрес электронной почты пользователя, который утверждал среду
properties.claimedByUserObjectId	string	Идентификатор объекта AAD пользователя, который утверждал среду
properties.claimedByUserPrincipalId	string	Идентификатор субъекта-пользователя пользователя, который утверждал среду
properties.isClaimed	boolean	Утверждается ли среда или нет
properties.lastKnownPowerState	string	Последнее известное состояние питания среды
properties.latestOperationResult	LatestOperationResult	Сведения о последней операции. ex: статус, ошибка
properties.networkInterface	NetworkInterface	Сведения о сети среды
properties.passwordLastReset	string (date-time)	После последнего сброса пароля в среде.
properties.provisioningState	string	Состояние подготовки ресурса.
properties.resourceSets	ResourceSet	Набор виртуальной машины и идентификатор параметра, для который он был создан
properties.totalUsage	string (duration)	Как долго среда использовалась пользователем лаборатории
properties.uniqueIdentifier	string	Уникальный неизменяемый идентификатор ресурса (GUID).
tags	object	Теги ресурса.
type	string	Тип ресурса.

LatestOperationResult

Object

Сведения о состоянии операции.

Имя	Тип	Описание
errorCode	string	Код ошибки при сбое.
errorMessage	string	Сообщение об ошибке.
httpMethod	string	HttpMethod — PUT/POST/DELETE для операции.
operationUrl	string	URL-адрес, используемый для проверки состояния длительной операции
requestUri	string	Запрос URI операции.
status	string	Текущее состояние операции.

NetworkInterface

Object

Сведения о сети среды

Имя	Тип	Описание
privateIpAddress	string	Частный IP-адрес виртуальной машины вычислений
rdpAuthority	string	Сведения о подключении для Windows
sshAuthority	string	Сведения о подключении для Linux
username	string	Имя пользователя виртуальной машины

ResourceSet

Object

Представляет виртуальную машину и идентификатор параметра, для который он был создан.

Имя	Тип	Описание
resourceSettingId	string	resourceSettingId для среды
vmResourceId	string	Идентификатор ресурса виртуальной машины для среды