Environments - Get

Service:

Lab Services

API Version:

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

With optional parameters:

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 de URI

Nome	Em	Obrigató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 lab.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID da assinatura.
api-version	query	True	string	Versão de API do cliente.
$expand	query		string	Especifique a consulta $expand. Exemplo: 'properties($expand=networkInterface)'

Respostas

Nome	Tipo	Description
200 OK	Environment	OK
Other Status Codes	CloudError	BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	Acessar o Microsoft Azure

Definições

Nome	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 de rede do ambiente
ResourceSet	Representa uma VM e a ID de configuração para a qual ela foi criada.

CloudError

Erro de uma solicitação REST.

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

CloudErrorBody

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

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

Environment

Representa uma instância de ambiente

Nome	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 email do usuário que reivindicou o ambiente
properties.claimedByUserObjectId	string	A ID do objeto do AAD do usuário que reivindicou o ambiente
properties.claimedByUserPrincipalId	string	A ID da entidade de usuário 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 operação mais recente. ex: status, error
properties.networkInterface	NetworkInterface	Detalhes de rede do ambiente
properties.passwordLastReset	string	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 a ID de configuração para a qual ela foi criada
properties.totalUsage	string	Por quanto tempo o ambiente foi usado por um usuário de laboratório
properties.uniqueIdentifier	string	O identificador imutável exclusivo de um recurso (Guid).
tags	object	As marcas do recurso.
type	string	Tipo do recurso.

LatestOperationResult

Detalhes do status de uma operação.

Nome	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 marcar operação de execução longa status
requestUri	string	Solicite o URI da operação.
status	string	O status atual da operação.

NetworkInterface

Detalhes de rede do ambiente

Nome	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

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

Nome	Tipo	Description
resourceSettingId	string	resourceSettingId para o ambiente
vmResourceId	string	ID do recurso de VM para o ambiente