Virtual Machines - List By Lab

Odwołanie

Usługa:: Lab Services

Wersja interfejsu API:: 2023-06-07

Pobierz wszystkie maszyny wirtualne dla laboratorium.
Zwraca listę wszystkich maszyn wirtualnych dla laboratorium.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
labName	path	True	string	Nazwa laboratorium, które jednoznacznie identyfikuje je w ramach planu laboratorium. Używane w identyfikatorach URI zasobów.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Filtr do zastosowania do operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PagedVirtualMachines	Żądanie zakończyło się pomyślnie; odpowiedź zawiera wszystkie maszyny wirtualne dla danego laboratorium.
Other Status Codes	ErrorResponse	Domyślna odpowiedź na błąd.

Przykłady

listVirtualMachine

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PagedVirtualMachines	Lista stronicowanych maszyn wirtualnych usług laboratoryjnych.
ProvisioningState	Bieżący stan aprowizacji maszyny wirtualnej.
ResourceOperationError	Szczegóły błędu najnowszej operacji w tym zasobie
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
VirtualMachine	Zasób maszyny wirtualnej laboratorium.
VirtualMachineConnectionProfile	Informacje o połączeniu maszyny wirtualnej
VirtualMachineState	Stan maszyny wirtualnej.
VirtualMachineType	Typ maszyny wirtualnej laboratorium.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

PagedVirtualMachines

Lista stronicowanych maszyn wirtualnych usług laboratoryjnych.

Nazwa	Typ	Opis
nextLink	string	Link umożliwiający pobranie następnej strony wyników maszyny wirtualnej.
value	VirtualMachine[]	Strona tablicy wyników maszyny wirtualnej.

ProvisioningState

Bieżący stan aprowizacji maszyny wirtualnej.

Nazwa	Typ	Opis
Creating	string	Zasób jest w trakcie tworzenia.
Deleting	string	Zasób jest w trakcie usuwania.
Failed	string	Poprzednia operacja zasobu nie powiodła się, pozostawiając zasób w złej kondycji.
Locked	string	Zasób jest zablokowany i zmiany są obecnie blokowane. Może to być spowodowane konserwacją lub zaplanowaną operacją. Stan powróci do powodzenia po zakończeniu operacji blokowania.
Succeeded	string	Zasób jest w dobrej kondycji po utworzeniu lub operacji aktualizacji.
Updating	string	Nowe wartości właściwości są stosowane do zasobu.

ResourceOperationError

Szczegóły błędu najnowszej operacji w tym zasobie

Nazwa	Typ	Opis
action	string	Akcja operacji, która nie powiodła się
code	string	Kod odpowiadający typowi niepowodzenia operacji
message	string	Komunikat o niepowodzeniu operacji
timestamp	string	Data/godzina wystąpienia błędu

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

VirtualMachine

Zasób maszyny wirtualnej laboratorium.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.claimedByUserId	string	Identyfikator użytkownika laboratorium (a nie identyfikator PUID!) osoby, która przejęła maszynę wirtualną.
properties.connectionProfile	VirtualMachineConnectionProfile	Profil, aby uzyskać informacje o nawiązywaniu połączenia z maszyną wirtualną.
properties.provisioningState	ProvisioningState	Bieżący stan aprowizacji maszyny wirtualnej.
properties.resourceOperationError	ResourceOperationError	Szczegóły błędu ostatniej operacji wykonanej w planie laboratorium.
properties.state	VirtualMachineState	Bieżący stan maszyny wirtualnej
properties.vmType	VirtualMachineType	Typ tego zasobu maszyny wirtualnej
systemData	systemData	Dane systemowe maszyny wirtualnej Laboratorium.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Informacje o połączeniu maszyny wirtualnej

Nazwa	Typ	Opis
adminUsername	string	Nazwa użytkownika używana do logowania się do maszyny wirtualnej jako administrator.
nonAdminUsername	string	Nazwa użytkownika używana do logowania się do maszyny wirtualnej jako administrator, jeśli istnieje.
privateIpAddress	string	Prywatny adres IP maszyny wirtualnej.
rdpAuthority	string	Nazwa portu i hosta oddzielona średnikami do nawiązywania połączenia za pośrednictwem protokołu RDP z maszyną wirtualną.
rdpInBrowserUrl	string	Adres URL do nawiązywania połączenia za pośrednictwem protokołu RDP z maszyną wirtualną w przeglądarce.
sshAuthority	string	Port i nazwa hosta oddzielona średnikami do nawiązywania połączenia za pośrednictwem protokołu SSH z maszyną wirtualną.
sshInBrowserUrl	string	Adres URL do nawiązywania połączenia za pośrednictwem protokołu SSH z maszyną wirtualną w przeglądarce.

VirtualMachineState

Stan maszyny wirtualnej.

Nazwa	Typ	Opis
Redeploying	string	Maszyna wirtualna jest wdrażana ponownie.
Reimaging	string	Maszyna wirtualna jest odtwarzana ponownie.
ResettingPassword	string	Hasło maszyny wirtualnej jest resetowane.
Running	string	Maszyna wirtualna jest uruchomiona.
Starting	string	Maszyna wirtualna jest uruchamiana.
Stopped	string	Maszyna wirtualna jest obecnie zatrzymana.
Stopping	string	Maszyna wirtualna jest zatrzymywana.

VirtualMachineType

Typ maszyny wirtualnej laboratorium.

Nazwa	Typ	Opis
Template	string	Maszyna wirtualna szablonu
User	string	Maszyna wirtualna użytkownika

Udostępnij za pośrednictwem