Virtual Machines - List By Lab

Servizio:: Lab Services

Versione API:: 2023-06-07

Ottenere tutte le macchine virtuali per un lab.
Restituisce un elenco di tutte le macchine virtuali per un lab.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
labName	path	True	string minLength: 1 maxLength: 100	Nome del lab che lo identifica in modo univoco all'interno del piano lab contenitore. Usato negli URI delle risorse.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$filter	query		string	Filtro da applicare all'operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PagedVirtualMachines	La richiesta ha avuto esito positivo; la risposta contiene tutte le macchine virtuali per il lab specificato.
Other Status Codes	ErrorResponse	Risposta di errore predefinita.

Esempio

listVirtualMachine

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PagedVirtualMachines	Elenco con paging delle macchine virtuali di Lab Services.
ProvisioningState	Stato di provisioning corrente della macchina virtuale.
ResourceOperationError	Dettagli dell'errore dell'operazione più recente in questa risorsa
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
VirtualMachine	Risorsa macchina virtuale lab.
VirtualMachineConnectionProfile	Informazioni di connessione per la macchina virtuale
VirtualMachineState	Stato di una macchina virtuale.
VirtualMachineType	Tipo di macchina virtuale lab.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PagedVirtualMachines

Object

Elenco con paging delle macchine virtuali di Lab Services.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per ottenere la pagina successiva dei risultati della macchina virtuale.
value	VirtualMachine[]	Pagina array dei risultati della macchina virtuale.

ProvisioningState

Enumerazione

Stato di provisioning corrente della macchina virtuale.

Valore	Descrizione
Creating	La risorsa è in corso di creazione.
Updating	Alla risorsa vengono applicati nuovi valori di proprietà.
Deleting	La risorsa è in corso di eliminazione.
Succeeded	La risorsa è in stato integro dopo la creazione o l'operazione di aggiornamento.
Failed	L'operazione precedente sulla risorsa non è riuscita a lasciare la risorsa in stato non integro.
Locked	La risorsa è bloccata e le modifiche sono attualmente bloccate. Ciò potrebbe essere dovuto alla manutenzione o a un'operazione pianificata. Lo stato tornerà al completamento dell'operazione di blocco.

ResourceOperationError

Object

Dettagli dell'errore dell'operazione più recente in questa risorsa

Nome	Tipo	Descrizione
action	string	Azione dell'operazione non riuscita
code	string	Codice che corrisponde al tipo di errore dell'operazione
message	string	Messaggio di errore dell'operazione
timestamp	string (date-time)	Datetime di quando si è verificato l'errore

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

VirtualMachine

Object

Risorsa macchina virtuale lab.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.claimedByUserId	string	ID utente del lab (non il PUID!) di chi ha richiesto la macchina virtuale.
properties.connectionProfile	VirtualMachineConnectionProfile	Profilare le informazioni sulla connessione alla macchina virtuale.
properties.provisioningState	ProvisioningState	Stato di provisioning corrente della macchina virtuale.
properties.resourceOperationError	ResourceOperationError	Dettagli dell'errore dell'ultima operazione eseguita sul piano lab.
properties.state	VirtualMachineState	Stato corrente della macchina virtuale
properties.vmType	VirtualMachineType	Tipo di questa risorsa di macchina virtuale
systemData	systemData	Dati di sistema della macchina virtuale Lab.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Object

Informazioni di connessione per la macchina virtuale

Nome	Tipo	Descrizione
adminUsername	string	Nome utente usato per accedere alla macchina virtuale come amministratore.
nonAdminUsername	string	Nome utente usato per accedere alla macchina virtuale come non amministratore, se presente.
privateIpAddress	string	Indirizzo IP privato della macchina virtuale.
rdpAuthority	string	Porta e nome host separati da punto e virgola per la connessione tramite protocollo RDP alla macchina virtuale.
rdpInBrowserUrl	string minLength: 3 maxLength: 2000	URL per la connessione tramite protocollo RDP alla macchina virtuale nel browser.
sshAuthority	string	Porta e nome host separati da punto e virgola per la connessione tramite protocollo SSH alla macchina virtuale.
sshInBrowserUrl	string minLength: 3 maxLength: 2000	URL per la connessione tramite protocollo SSH alla macchina virtuale nel browser.

VirtualMachineState

Enumerazione

Stato di una macchina virtuale.

Valore	Descrizione
Stopped	La macchina virtuale è attualmente arrestata.
Starting	La macchina virtuale viene avviata.
Running	La macchina virtuale è in esecuzione.
Stopping	La macchina virtuale viene arrestata.
ResettingPassword	La password della macchina virtuale viene reimpostata.
Reimaging	Viene ricreata l'immagine della macchina virtuale.
Redeploying	La macchina virtuale viene ridistribuita.

VirtualMachineType

Enumerazione

Tipo di macchina virtuale lab.

Valore	Descrizione
User	Una macchina virtuale utente
Template	Una macchina virtuale modello

Condividi tramite

Virtual Machines - List By Lab

Parametri dell'URI

Risposte

Esempio

listVirtualMachine

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType