Virtual Machines - List By Lab

Referência

Service:: Lab Services

API Version:: 2023-06-07

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

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
labName	path	True	string	O nome do laboratório que o identifica exclusivamente no plano de laboratório. Utilizado em URIs de recursos.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$filter	query		string	O filtro a aplicar à operação.

Respostas

Name	Tipo	Description
200 OK	PagedVirtualMachines	O pedido foi bem-sucedido; a resposta contém todas as máquinas virtuais para o laboratório especificado.
Other Status Codes	ErrorResponse	A resposta de erro predefinida.

Exemplos

listVirtualMachine

Sample Request

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

Sample Response

Status code:: 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

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
PagedVirtualMachines	Lista paginada de máquinas virtuais de serviços de laboratório.
ProvisioningState	Estado de aprovisionamento atual da máquina virtual.
ResourceOperationError	Detalhes do erro da falha da 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 ligação da máquina virtual
VirtualMachineState	O estado de uma máquina virtual.
VirtualMachineType	O tipo de máquina virtual de laboratório.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

O detalhe do erro.

Name	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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

PagedVirtualMachines

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

Name	Tipo	Description
nextLink	string	A ligação para obter a página seguinte dos resultados da máquina virtual.
value	VirtualMachine[]	A página de matriz dos resultados da máquina virtual.

ProvisioningState

Estado de aprovisionamento atual da máquina virtual.

Name	Tipo	Description
Creating	string	O recurso está a ser criado.
Deleting	string	O recurso está a ser eliminado.
Failed	string	A operação anterior no recurso falhou ao deixar o recurso em mau estado de funcionamento.
Locked	string	O recurso está bloqueado e as alterações estão atualmente bloqueadas. Tal pode dever-se à manutenção ou a uma operação agendada. O estado voltará a ser bem-sucedido assim que a operação de bloqueio estiver concluída.
Succeeded	string	O recurso está em bom estado de funcionamento após a criação ou operação de atualização.
Updating	string	Estão a ser aplicados novos valores de propriedade ao recurso.

ResourceOperationError

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

Name	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	O datetime de quando ocorreu o erro

systemData

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

Name	Tipo	Description
createdAt	string	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	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

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

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.claimedByUserId	string	O ID do utilizador do laboratório (não o PUID!) de quem reivindicou a máquina virtual.
properties.connectionProfile	VirtualMachineConnectionProfile	Perfil para obter informações sobre como ligar à máquina virtual.
properties.provisioningState	ProvisioningState	Estado de aprovisionamento atual da máquina virtual.
properties.resourceOperationError	ResourceOperationError	Detalhes do erro da última operação efetuada no plano de laboratório.
properties.state	VirtualMachineState	O estado atual da máquina virtual
properties.vmType	VirtualMachineType	O tipo deste recurso de VM
systemData	systemData	Dados do sistema da máquina virtual lab.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

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

Name	Tipo	Description
adminUsername	string	O nome de utilizador utilizado para iniciar sessão na máquina virtual como administrador.
nonAdminUsername	string	O nome de utilizador utilizado para iniciar sessão na máquina virtual como não administrador, se existir.
privateIpAddress	string	O endereço IP privado da máquina virtual.
rdpAuthority	string	Nome da porta e do anfitrião separados por ponto e vírgula para ligar através do protocolo RDP à máquina virtual.
rdpInBrowserUrl	string	URL para ligar através do protocolo RDP à máquina virtual no browser.
sshAuthority	string	Nome da porta e do anfitrião separados por ponto e vírgula para ligar através do protocolo SSH à máquina virtual.
sshInBrowserUrl	string	URL para ligar através do protocolo SSH à máquina virtual no browser.

VirtualMachineState

O estado de uma máquina virtual.

Name	Tipo	Description
Redeploying	string	A VM está a ser reimplementada.
Reimaging	string	A VM está a ser reimageda.
ResettingPassword	string	A palavra-passe da VM está a ser reposta.
Running	string	A VM está em execução.
Starting	string	A VM está a começar.
Stopped	string	A VM está atualmente parada.
Stopping	string	A VM está a parar.

VirtualMachineType

O tipo de máquina virtual de laboratório.

Name	Tipo	Description
Template	string	Uma VM de modelo
User	string	Uma VM de utilizador