Environments - Get

Serviço:

Lab Services

Versão da API:

2018-10-15

Obter ambiente

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
environmentName	path	True	string	O nome do ambiente.
environmentSettingName	path	True	string	O nome da configuração do ambiente.
labAccountName	path	True	string	O nome da conta do laboratório.
labName	path	True	string	O nome do laboratório.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	O ID da subscrição.
api-version	query	True	string	Versão da API do cliente.
$expand	query		string	Especifique o $expand consulta. Exemplo: 'properties($expand=networkInterface)'

Respostas

Name	Tipo	Description
200 OK	Environment	OK
Other Status Codes	CloudError	Pedido Inválido

Segurança

azure_auth

Subsídio implícito OAuth2

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Acessar o Microsoft Azure

Definições

Name	Description
CloudError	Erro de uma solicitação REST.
CloudErrorBody	Corpo de um erro de uma solicitação REST.
Environment	Representa uma instância de ambiente
LatestOperationResult	Detalhes do status de uma operação.
NetworkInterface	Detalhes da rede do ambiente
ResourceSet	Representa uma VM e a configuração Id para a qual ela foi criada.

CloudError

Object

Erro de uma solicitação REST.

Name	Tipo	Description
error	CloudErrorBody	Corpo de um erro de uma solicitação REST.

CloudErrorBody

Object

Corpo de um erro de uma solicitação REST.

Name	Tipo	Description
code	string
details	CloudErrorBody[]	Erros internos.
message	string
target	string

Environment

Object

Representa uma instância de ambiente

Name	Tipo	Description
id	string	O identificador do recurso.
location	string	A localização do recurso.
name	string	O nome do recurso.
properties.claimedByUserName	string	O nome ou endereço de e-mail do usuário que reivindicou o ambiente
properties.claimedByUserObjectId	string	A ID do objeto AAD do usuário que reivindicou o ambiente
properties.claimedByUserPrincipalId	string	O ID principal do usuário que reivindicou o ambiente
properties.isClaimed	boolean	O ambiente é reivindicado ou não
properties.lastKnownPowerState	string	Último estado de energia conhecido do ambiente
properties.latestOperationResult	LatestOperationResult	Os detalhes da última operação. ex: status, erro
properties.networkInterface	NetworkInterface	Detalhes da rede do ambiente
properties.passwordLastReset	string (date-time)	Quando a senha foi redefinida pela última vez no ambiente.
properties.provisioningState	string	O status de provisionamento do recurso.
properties.resourceSets	ResourceSet	O conjunto de uma VM e o id de configuração para o qual ela foi criada
properties.totalUsage	string (duration)	Há quanto tempo o ambiente é usado por um usuário de laboratório
properties.uniqueIdentifier	string	O identificador único imutável de um recurso (Guid).
tags	object	As tags do recurso.
type	string	O tipo do recurso.

LatestOperationResult

Object

Detalhes do status de uma operação.

Name	Tipo	Description
errorCode	string	Código de erro em caso de falha.
errorMessage	string	A mensagem de erro.
httpMethod	string	O HttpMethod - PUT/POST/DELETE para a operação.
operationUrl	string	A URL a ser usada para verificar o status da operação de longa duração
requestUri	string	Solicitar URI da operação.
status	string	O status atual da operação.

NetworkInterface

Object

Detalhes da rede do ambiente

Name	Tipo	Description
privateIpAddress	string	Endereço PrivateIp da VM de computação
rdpAuthority	string	Informações de conexão para Windows
sshAuthority	string	Informações de conexão para Linux
username	string	Nome de usuário da VM

ResourceSet

Object

Representa uma VM e a configuração Id para a qual ela foi criada.

Name	Tipo	Description
resourceSettingId	string	resourceSettingId para o ambiente
vmResourceId	string	ID do recurso da VM para o ambiente