Virtual Machines - List By Lab

Referentie

Service:: Lab Services

API-versie:: 2023-06-07

Alle virtuele machines voor een lab ophalen.
Retourneert een lijst met alle virtuele machines voor een lab.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
labName	path	True	string	De naam van het lab dat het lab uniek identificeert in het labplan. Wordt gebruikt in resource-URI's.
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	Het filter dat moet worden toegepast op de bewerking.

Antwoorden

Name	Type	Description
200 OK	PagedVirtualMachines	De aanvraag is geslaagd; antwoord bevat alle virtuele machines voor het opgegeven lab.
Other Status Codes	ErrorResponse	Het standaardfoutantwoord.

Voorbeelden

listVirtualMachine

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
PagedVirtualMachines	Paginalijst met virtuele machines van labservices.
ProvisioningState	Huidige inrichtingsstatus van de virtuele machine.
ResourceOperationError	Foutdetails van de meest recente bewerkingsfout in deze resource
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
VirtualMachine	Een labresource voor virtuele machines.
VirtualMachineConnectionProfile	De verbindingsgegevens voor de virtuele machine
VirtualMachineState	De status van een virtuele machine.
VirtualMachineType	Het type van de virtuele labmachine.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

PagedVirtualMachines

Paginalijst met virtuele machines van labservices.

Name	Type	Description
nextLink	string	De koppeling om de volgende pagina met resultaten van virtuele machines op te halen.
value	VirtualMachine[]	De matrixpagina van de resultaten van de virtuele machine.

ProvisioningState

Huidige inrichtingsstatus van de virtuele machine.

Name	Type	Description
Creating	string	De resource wordt gemaakt.
Deleting	string	De resource wordt verwijderd.
Failed	string	De vorige bewerking op de resource is mislukt, waardoor de resource niet in orde is.
Locked	string	De resource is vergrendeld en wijzigingen worden momenteel geblokkeerd. Dit kan worden veroorzaakt door onderhoud of een geplande bewerking. De status wordt teruggezet naar geslaagd zodra de vergrendelingsbewerking is voltooid.
Succeeded	string	Resource heeft een goede status na het maken of bijwerken.
Updating	string	Er worden nieuwe eigenschapswaarden toegepast op de resource.

ResourceOperationError

Foutdetails van de meest recente bewerkingsfout in deze resource

Name	Type	Description
action	string	De bewerkingsactie die is mislukt
code	string	De code die overeenkomt met het type bewerkingsfout
message	string	Het foutbericht van de bewerking
timestamp	string	De datum/tijd waarop de fout is opgetreden

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

VirtualMachine

Een labresource voor virtuele machines.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.claimedByUserId	string	De labgebruikers-id (niet de PUID!) van wie de virtuele machine heeft geclaimd.
properties.connectionProfile	VirtualMachineConnectionProfile	Profiel voor informatie over het maken van verbinding met de virtuele machine.
properties.provisioningState	ProvisioningState	Huidige inrichtingsstatus van de virtuele machine.
properties.resourceOperationError	ResourceOperationError	Foutdetails van de laatste bewerking die is uitgevoerd op het labplan.
properties.state	VirtualMachineState	De huidige status van de virtuele machine
properties.vmType	VirtualMachineType	Het type van deze VM-resource
systemData	systemData	Systeemgegevens van de virtuele machine van het lab.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

VirtualMachineConnectionProfile

De verbindingsgegevens voor de virtuele machine

Name	Type	Description
adminUsername	string	De gebruikersnaam die wordt gebruikt om u als beheerder aan te melden bij de virtuele machine.
nonAdminUsername	string	De gebruikersnaam die wordt gebruikt om u als niet-beheerder aan te melden bij de virtuele machine, als deze bestaat.
privateIpAddress	string	Het privé-IP-adres van de virtuele machine.
rdpAuthority	string	Poort- en hostnaam gescheiden door puntkomma's om via het RDP-protocol verbinding te maken met de virtuele machine.
rdpInBrowserUrl	string	URL om via het RDP-protocol verbinding te maken met de virtuele machine in de browser.
sshAuthority	string	Poort- en hostnaam gescheiden door puntkomma's om via het SSH-protocol verbinding te maken met de virtuele machine.
sshInBrowserUrl	string	URL om via het SSH-protocol verbinding te maken met de virtuele machine in de browser.

VirtualMachineState

De status van een virtuele machine.

Name	Type	Description
Redeploying	string	De VM wordt opnieuw geïmplementeerd.
Reimaging	string	Er wordt een nieuwe installatiekopie van de VM gemaakt.
ResettingPassword	string	Het VM-wachtwoord wordt opnieuw ingesteld.
Running	string	De VM wordt uitgevoerd.
Starting	string	De VM wordt gestart.
Stopped	string	De VM is momenteel gestopt.
Stopping	string	De VM wordt gestopt.

VirtualMachineType

Het type van de virtuele labmachine.

Name	Type	Description
Template	string	Een sjabloon-VM
User	string	Een gebruikers-VM

Delen via