Virtual Machines - List By Lab

Riferimento

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	Nome del lab che lo identifica in modo univoco all'interno del piano del lab. Usato negli URI delle risorse.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	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; 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 sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PagedVirtualMachines	Elenco in pagina delle macchine virtuali dei servizi lab.
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

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

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

ErrorDetail

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

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PagedVirtualMachines

Elenco in pagina delle macchine virtuali dei servizi lab.

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

ProvisioningState

Stato di provisioning corrente della macchina virtuale.

Nome	Tipo	Descrizione
Creating	string	La risorsa si trova nel processo di creazione.
Deleting	string	La risorsa si trova nel processo di eliminazione.
Failed	string	L'operazione precedente sulla risorsa non è riuscita a lasciare la risorsa nello stato non integro.
Locked	string	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.
Succeeded	string	La risorsa è in stato integro dopo la creazione o l'operazione di aggiornamento.
Updating	string	I nuovi valori delle proprietà vengono applicati alla risorsa.

ResourceOperationError

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	Datatime di quando si è verificato l'errore

systemData

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

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

VirtualMachine

Risorsa macchina virtuale lab.

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

VirtualMachineConnectionProfile

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	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	URL per la connessione tramite protocollo SSH alla macchina virtuale nel browser.

VirtualMachineState

Stato di una macchina virtuale.

Nome	Tipo	Descrizione
Redeploying	string	La macchina virtuale viene ridistribuita.
Reimaging	string	La macchina virtuale viene ricreata.
ResettingPassword	string	La password della macchina virtuale viene reimpostata.
Running	string	La macchina virtuale è in esecuzione.
Starting	string	La macchina virtuale viene avviata.
Stopped	string	La macchina virtuale è attualmente arrestata.
Stopping	string	La macchina virtuale viene arrestata.

VirtualMachineType

Tipo di macchina virtuale lab.

Nome	Tipo	Descrizione
Template	string	Macchina virtuale modello
User	string	Macchina virtuale utente

Condividi tramite