Virtual Machines - List By Lab

Service:

Lab Services

API Version:

2023-06-07

Hämta alla virtuella datorer för ett labb.
Returnerar en lista över alla virtuella datorer för ett labb.

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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
labName	path	True	string	Namnet på labbet som unikt identifierar det i en labbplan. Används i resurs-URI:er.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
$filter	query		string	Filtret som ska tillämpas på åtgärden.

Svar

Name	Typ	Description
200 OK	PagedVirtualMachines	Begäran lyckades. svaret innehåller alla virtuella datorer för det angivna labbet.
Other Status Codes	ErrorResponse	Standardfelsvaret.

Exempel

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"
      }
    }
  ]
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
PagedVirtualMachines	Sidlista över virtuella datorer för labbtjänster.
ProvisioningState	Aktuellt etableringstillstånd för den virtuella datorn.
ResourceOperationError	Felinformation om det senaste åtgärdsfelet på den här resursen
systemData	Metadata som rör skapande och senaste ändring av resursen.
VirtualMachine	En labbresurs för virtuella datorer.
VirtualMachineConnectionProfile	Anslutningsinformationen för den virtuella datorn
VirtualMachineState	Tillståndet för en virtuell dator.
VirtualMachineType	Typen av den virtuella labbdatorn.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

PagedVirtualMachines

Sidlista över virtuella datorer för labbtjänster.

Name	Typ	Description
nextLink	string	Länken för att hämta nästa sida med resultat för virtuella datorer.
value	VirtualMachine[]	Matrissidan för resultatet för den virtuella datorn.

ProvisioningState

Aktuellt etableringstillstånd för den virtuella datorn.

Name	Typ	Description
Creating	string	Resursen håller på att skapas.
Deleting	string	Resursen håller på att tas bort.
Failed	string	Föregående åtgärd på resursen misslyckades med att lämna resursen i feltillstånd.
Locked	string	Resursen är låst och ändringar blockeras för närvarande. Detta kan bero på underhåll eller en schemalagd åtgärd. Tillståndet återgår till lyckades när låsningsåtgärden har slutförts.
Succeeded	string	Resursen är i felfritt tillstånd när den har skapats eller uppdaterats.
Updating	string	Nya egenskapsvärden tillämpas på resursen.

ResourceOperationError

Felinformation om det senaste åtgärdsfelet på den här resursen

Name	Typ	Description
action	string	Åtgärdsåtgärden som misslyckades
code	string	Koden som motsvarar typen av åtgärdsfel
message	string	Meddelandet om åtgärdsfel
timestamp	string	Datetime för när felet inträffade

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

VirtualMachine

En labbresurs för virtuella datorer.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.claimedByUserId	string	Labbanvändar-ID :t (inte PUID!) för vem som gjorde anspråk på den virtuella datorn.
properties.connectionProfile	VirtualMachineConnectionProfile	Profil för information om hur du ansluter till den virtuella datorn.
properties.provisioningState	ProvisioningState	Aktuellt etableringstillstånd för den virtuella datorn.
properties.resourceOperationError	ResourceOperationError	Felinformation om den senaste åtgärden som utfördes i labbplanen.
properties.state	VirtualMachineState	Den virtuella datorns aktuella tillstånd
properties.vmType	VirtualMachineType	Typen av den här VM-resursen
systemData	systemData	Systemdata för den virtuella datorn Lab.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Anslutningsinformationen för den virtuella datorn

Name	Typ	Description
adminUsername	string	Användarnamnet som används för att logga in på den virtuella datorn som administratör.
nonAdminUsername	string	Användarnamnet som används för att logga in på den virtuella datorn som icke-administratör, om det finns något.
privateIpAddress	string	Den virtuella datorns privata IP-adress.
rdpAuthority	string	Port- och värdnamn avgränsade med semikolon för anslutning via RDP-protokoll till den virtuella datorn.
rdpInBrowserUrl	string	URL för att ansluta via RDP-protokollet till den virtuella datorn i webbläsaren.
sshAuthority	string	Port- och värdnamn avgränsade med semikolon för anslutning via SSH-protokoll till den virtuella datorn.
sshInBrowserUrl	string	URL för att ansluta via SSH-protokollet till den virtuella datorn i webbläsaren.

VirtualMachineState

Tillståndet för en virtuell dator.

Name	Typ	Description
Redeploying	string	Den virtuella datorn distribueras om.
Reimaging	string	Den virtuella datorn håller på att förnyas.
ResettingPassword	string	Lösenordet för den virtuella datorn återställs.
Running	string	Den virtuella datorn körs.
Starting	string	Den virtuella datorn startar.
Stopped	string	Den virtuella datorn stoppas för närvarande.
Stopping	string	Den virtuella datorn stoppas.

VirtualMachineType

Typen av den virtuella labbdatorn.

Name	Typ	Description
Template	string	En virtuell malldator
User	string	En virtuell användardator