Environments - Get

Service:

Lab Services

Version d'API:

2018-10-15

Obtenir l’environnement

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentName	path	True	string	Nom de l’environnement.
environmentSettingName	path	True	string	Nom du paramètre d’environnement.
labAccountName	path	True	string	Nom du compte lab.
labName	path	True	string	Nom du labo.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	ID d’abonnement.
api-version	query	True	string	Version de l’API cliente.
$expand	query		string	Spécifiez la requête $expand. Exemple : 'properties($expand=networkInterface)'

Réponses

Nom	Type	Description
200 OK	Environment	D’ACCORD
Other Status Codes	CloudError	Requête incorrecte

Sécurité

azure_auth

Octroi implicite OAuth2

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Accéder à Microsoft Azure

Définitions

Nom	Description
CloudError	Erreur à partir d’une requête REST.
CloudErrorBody	Corps d’une erreur à partir d’une requête REST.
Environment	Représente une instance d’environnement
LatestOperationResult	Détails de l’état d’une opération.
NetworkInterface	Détails réseau de l’environnement
ResourceSet	Représente une machine virtuelle et l’ID de paramètre pour lequel elle a été créée.

CloudError

Object

Erreur à partir d’une requête REST.

Nom	Type	Description
error	CloudErrorBody	Corps d’une erreur à partir d’une requête REST.

CloudErrorBody

Object

Corps d’une erreur à partir d’une requête REST.

Nom	Type	Description
code	string
details	CloudErrorBody[]	Erreurs internes.
message	string
target	string

Environment

Object

Représente une instance d’environnement

Nom	Type	Description
id	string	Identificateur de la ressource.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.claimedByUserName	string	Nom ou adresse e-mail de l’utilisateur qui a revendiqué l’environnement
properties.claimedByUserObjectId	string	ID d’objet AAD de l’utilisateur qui a revendiqué l’environnement
properties.claimedByUserPrincipalId	string	ID d’utilisateur principal de l’utilisateur qui a revendiqué l’environnement
properties.isClaimed	boolean	L’environnement est-il revendiqué ou non
properties.lastKnownPowerState	string	Dernier état connu de l’alimentation de l’environnement
properties.latestOperationResult	LatestOperationResult	Détails de la dernière opération. ex : état, erreur
properties.networkInterface	NetworkInterface	Détails réseau de l’environnement
properties.passwordLastReset	string (date-time)	Lorsque le mot de passe a été réinitialisé pour la dernière fois sur l’environnement.
properties.provisioningState	string	État d’approvisionnement de la ressource.
properties.resourceSets	ResourceSet	L’ensemble d’une machine virtuelle et l’ID de paramètre qu’il a été créé pour
properties.totalUsage	string (duration)	Durée pendant laquelle l’environnement a été utilisé par un utilisateur lab
properties.uniqueIdentifier	string	Identificateur immuable unique d’une ressource (GUID).
tags	object	Balises de la ressource.
type	string	Type de la ressource.

LatestOperationResult

Object

Détails de l’état d’une opération.

Nom	Type	Description
errorCode	string	Code d’erreur en cas d’échec.
errorMessage	string	Message d’erreur.
httpMethod	string	HttpMethod - PUT/POST/DELETE pour l’opération.
operationUrl	string	URL à utiliser pour vérifier l’état de l’opération de longue durée
requestUri	string	URI de requête de l’opération.
status	string	État actuel de l’opération.

NetworkInterface

Object

Détails réseau de l’environnement

Nom	Type	Description
privateIpAddress	string	Adresse PrivateIp de la machine virtuelle de calcul
rdpAuthority	string	Informations de connexion pour Windows
sshAuthority	string	Informations de connexion pour Linux
username	string	Nom d’utilisateur de la machine virtuelle

ResourceSet

Object

Représente une machine virtuelle et l’ID de paramètre pour lequel elle a été créée.

Nom	Type	Description
resourceSettingId	string	resourceSettingId pour l’environnement
vmResourceId	string	ID de ressource de machine virtuelle pour l’environnement