Virtual Machines - List By Lab

Tjänst:: 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

Med valfria parametrar:

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 minLength: 1 maxLength: 100	Namnet på labbet som unikt identifierar det i en labbplan. Används i resurs-URI:er.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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	Sidad lista ö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 virtuell labbdatorresurs.
VirtualMachineConnectionProfile	Anslutningsinformationen för den virtuella datorn
VirtualMachineState	Tillståndet för en virtuell dator.
VirtualMachineType	Typen av den virtuella labbdatorn.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

PagedVirtualMachines

Objekt

Sidad lista ö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 resultat från virtuella datorer.

ProvisioningState

Uppräkning

Aktuellt etableringstillstånd för den virtuella datorn.

Värde	Description
Creating	Resursen håller på att skapas.
Updating	Nya egenskapsvärden tillämpas på resursen.
Deleting	Resursen håller på att tas bort.
Succeeded	Resursen är i felfritt tillstånd när den har skapats eller uppdaterats.
Failed	Föregående åtgärd på resursen har misslyckats med att lämna resursen i feltillstånd.
Locked	Resursen är låst och ändringarna är för närvarande blockerade. 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.

ResourceOperationError

Objekt

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

Name	Typ	Description
action	string	Åtgärdsåtgärden som misslyckades
code	string	Den kod som motsvarar typen av åtgärdsfel
message	string	Meddelandet om åtgärdsfel
timestamp	string (date-time)	Datetime för när felet inträffade

systemData

Objekt

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

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	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

Objekt

En virtuell labbdatorresurs.

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

Objekt

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 minLength: 3 maxLength: 2000	URL för anslutning via RDP-protokoll 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 minLength: 3 maxLength: 2000	URL för anslutning via SSH-protokoll till den virtuella datorn i webbläsaren.

VirtualMachineState

Uppräkning

Tillståndet för en virtuell dator.

Värde	Description
Stopped	Den virtuella datorn är för närvarande stoppad.
Starting	Den virtuella datorn startar.
Running	Den virtuella datorn körs.
Stopping	Den virtuella datorn stoppas.
ResettingPassword	Lösenordet för den virtuella datorn återställs.
Reimaging	Den virtuella datorn återskapas.
Redeploying	Den virtuella datorn distribueras om.

VirtualMachineType

Uppräkning

Typen av den virtuella labbdatorn.

Värde	Description
User	En virtuell användardator
Template	En virtuell malldator

Dela via

Virtual Machines - List By Lab

URI-parametrar

Svar

Exempel

listVirtualMachine

Exempelbegäran

Exempelsvar

Definitioner

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType