Virtual Machines - List By Lab

Serviço:: Lab Services

Versão da API:: 2023-06-07

Obtenha todas as máquinas virtuais para um laboratório.
Retorna uma lista de todas as máquinas virtuais para um laboratório.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string minLength: 1 maxLength: 100	O nome do laboratório que o identifica exclusivamente dentro do plano de laboratório. Usado em URIs de recurso.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	O filtro a ser aplicado à operação.

Respostas

Nome	Tipo	Description
200 OK	PagedVirtualMachines	A solicitação foi bem-sucedida; A resposta contém todas as máquinas virtuais para o laboratório especificado.
Other Status Codes	ErrorResponse	A resposta de erro padrão.

Exemplos

listVirtualMachine

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines?api-version=2023-06-07

Resposta de exemplo

Código de status:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines/template",
      "name": "default",
      "type": "Microsoft.LabServices/VirtualMachine",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Running",
        "connectionProfile": {
          "privateIpAddress": "192.168.2.1",
          "sshAuthority": "vm-42.contoso.com:22",
          "sshInBrowserUrl": "vm-42.contoso.com",
          "rdpAuthority": "vm-42.contoso.com:3389",
          "rdpInBrowserUrl": "vm-42.contoso.com",
          "adminUsername": "user123"
        },
        "claimedByUserId": "testuser567",
        "vmType": "Template"
      }
    }
  ]
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PagedVirtualMachines	Lista de páginas de máquinas virtuais de serviços de laboratório.
ProvisioningState	Estado de provisionamento atual da máquina virtual.
ResourceOperationError	Detalhes do erro da falha de operação mais recente neste recurso
systemData	Metadados relativos à criação e última modificação do recurso.
VirtualMachine	Um recurso de máquina virtual de laboratório.
VirtualMachineConnectionProfile	As informações de conexão da máquina virtual
VirtualMachineState	O estado de uma máquina virtual.
VirtualMachineType	O tipo da máquina virtual do laboratório.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PagedVirtualMachines

Objeto

Lista de páginas de máquinas virtuais de serviços de laboratório.

Nome	Tipo	Description
nextLink	string	O link para obter a próxima página de resultados da máquina virtual.
value	VirtualMachine[]	A página de matriz dos resultados da máquina virtual.

ProvisioningState

Enumeração

Estado de provisionamento atual da máquina virtual.

Valor	Description
Creating	O recurso está em processo de criação.
Updating	Novos valores de propriedade estão sendo aplicados ao recurso.
Deleting	O recurso está em processo de exclusão.
Succeeded	O recurso está em estado íntegro após a operação de criação ou atualização.
Failed	A operação anterior no recurso falhou ao deixar o recurso em estado não íntegro.
Locked	O recurso está bloqueado e as alterações estão bloqueadas no momento. Isso pode ser devido à manutenção ou a uma operação agendada. O estado voltará a ser bem-sucedido após a conclusão da operação de bloqueio.

ResourceOperationError

Objeto

Detalhes do erro da falha de operação mais recente neste recurso

Nome	Tipo	Description
action	string	A ação de operação que falhou
code	string	O código que corresponde ao tipo de falha de operação
message	string	A mensagem de falha da operação
timestamp	string (date-time)	O datetime de quando o erro ocorreu

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

VirtualMachine

Objeto

Um recurso de máquina virtual de laboratório.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.claimedByUserId	string	A ID do usuário do laboratório (não a PUID!) de quem reivindicou a máquina virtual.
properties.connectionProfile	VirtualMachineConnectionProfile	Crie um perfil para obter informações sobre como se conectar à máquina virtual.
properties.provisioningState	ProvisioningState	Estado de provisionamento atual da máquina virtual.
properties.resourceOperationError	ResourceOperationError	Detalhes do erro da última operação feita no plano de laboratório.
properties.state	VirtualMachineState	O estado atual da máquina virtual
properties.vmType	VirtualMachineType	O tipo desse recurso de VM
systemData	systemData	Dados do sistema da máquina virtual do Laboratório.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Objeto

As informações de conexão da máquina virtual

Nome	Tipo	Description
adminUsername	string	O nome de usuário usado para fazer logon na máquina virtual como administrador.
nonAdminUsername	string	O nome de usuário usado para fazer logon na máquina virtual como não administrador, se houver.
privateIpAddress	string	O endereço IP privado da máquina virtual.
rdpAuthority	string	Nome da porta e do host separados por ponto-e-vírgula para conexão por meio do protocolo RDP à máquina virtual.
rdpInBrowserUrl	string minLength: 3 maxLength: 2000	URL para se conectar via protocolo RDP à máquina virtual no navegador.
sshAuthority	string	Nome da porta e do host separados por ponto-e-vírgula para conexão por meio do protocolo SSH à máquina virtual.
sshInBrowserUrl	string minLength: 3 maxLength: 2000	URL para se conectar por meio do protocolo SSH à máquina virtual no navegador.

VirtualMachineState

Enumeração

O estado de uma máquina virtual.

Valor	Description
Stopped	A VM está parada no momento.
Starting	A VM está começando.
Running	A VM está em execução.
Stopping	A VM está parando.
ResettingPassword	A senha da VM está sendo redefinida.
Reimaging	A VM está sendo reimageada.
Redeploying	A VM está sendo reimplantada.

VirtualMachineType

Enumeração

O tipo da máquina virtual do laboratório.

Valor	Description
User	Uma VM de usuário
Template	Uma VM de modelo

Compartilhar via

Virtual Machines - List By Lab

Parâmetros de URI

Respostas

Exemplos

listVirtualMachine

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType