Virtual Machines - List By Lab

  • Referencia
Service:
Lab Services
API Version:
2023-06-07

Szerezze be a labor összes virtuális gépét.
Egy tesztkörnyezet összes virtuális gépének listáját adja vissza.

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-paraméterek

Name In Kötelező Típus Description
labName
 path True

string

Annak a tesztkörnyezetnek a neve, amely egyedileg azonosítja azt a tesztkörnyezettervben. Erőforrás-URI-kban használatos.
resourceGroupName
 path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId
 path True

string

A cél-előfizetés azonosítója.
api-version
 query True

string

A művelethez használandó API-verzió.
$filter
 query

string

A műveletre alkalmazandó szűrő.

Válaszok

Name Típus Description
200 OK

PagedVirtualMachines

A kérés sikeres volt; A válasz az adott tesztkörnyezet összes virtuális gépét tartalmazza.
Other Status Codes

ErrorResponse

Az alapértelmezett hibaválasz.

Példák

listVirtualMachine

Sample Request

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

Definíciók

Name Description
createdByType

Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.
ErrorDetail

A hiba részletei.
ErrorResponse

Hibaválasz
PagedVirtualMachines

A tesztkörnyezeti szolgáltatások virtuális gépeinek lapozott listája.
ProvisioningState

A virtuális gép aktuális kiépítési állapota.
ResourceOperationError

Az erőforrás legutóbbi művelethibájának hibaadatai
systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
VirtualMachine

Tesztkörnyezeti virtuálisgép-erőforrás.
VirtualMachineConnectionProfile

A virtuális gép kapcsolati adatai
VirtualMachineState

Egy virtuális gép állapota.
VirtualMachineType

A tesztkörnyezet virtuális gépének típusa.

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.
type

string

A további információtípus.

ErrorDetail

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.
code

string

A hibakód.
details

ErrorDetail[]

A hiba részletei.
message

string

A hibaüzenet.
target

string

A hibacél.

ErrorResponse

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

PagedVirtualMachines

A tesztkörnyezeti szolgáltatások virtuális gépeinek lapozott listája.

Name Típus Description
nextLink

string

A virtuálisgép-eredmények következő oldalának lekérésére szolgáló hivatkozás.
value

VirtualMachine[]

A virtuális gépek eredményeinek tömboldala.

ProvisioningState

A virtuális gép aktuális kiépítési állapota.

Name Típus Description
Creating

string

Az erőforrás létrehozása folyamatban van.
Deleting

string

Az erőforrás törlése folyamatban van.
Failed

string

Az erőforrás előző művelete sikertelen volt, és nem kifogástalan állapotban hagyta az erőforrást.
Locked

string

Az erőforrás zárolva van, és a módosítások jelenleg le vannak tiltva. Ennek oka lehet karbantartás vagy ütemezett művelet. Az állapot a zárolási művelet befejeződése után ismét sikeres lesz.
Succeeded

string

Az erőforrás kifogástalan állapotban van a létrehozási vagy frissítési művelet után.
Updating

string

Új tulajdonságértékek lesznek alkalmazva az erőforrásra.

ResourceOperationError

Az erőforrás legutóbbi művelethibájának hibaadatai

Name Típus Description
action

string

A sikertelen művelet
code

string

A művelethiba típusának megfelelő kód
message

string

A művelet sikertelen üzenete
timestamp

string

A hiba bekövetkezésének dátuma

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).
createdBy

string

Az erőforrást létrehozó identitás.
createdByType

createdByType

Az erőforrást létrehozó identitás típusa.
lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy

string

Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

VirtualMachine

Tesztkörnyezeti virtuálisgép-erőforrás.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Az erőforrás neve
properties.claimedByUserId

string

A tesztkörnyezet felhasználói azonosítója (nem a PUID!), amely a virtuális gépet igényelte.
properties.connectionProfile

VirtualMachineConnectionProfile

Profil a virtuális géphez való csatlakozással kapcsolatos információkért.
properties.provisioningState

ProvisioningState

A virtuális gép aktuális kiépítési állapota.
properties.resourceOperationError

ResourceOperationError

A tesztkörnyezeti terv legutóbbi műveletének hibaadatai.
properties.state

VirtualMachineState

A virtuális gép aktuális állapota
properties.vmType

VirtualMachineType

A virtuálisgép-erőforrás típusa
systemData

systemData

A lab virtuális gép rendszeradatai.
type

string

Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

A virtuális gép kapcsolati adatai

Name Típus Description
adminUsername

string

A virtuális gépre rendszergazdaként való bejelentkezéshez használt felhasználónév.
nonAdminUsername

string

A virtuális gépre nem rendszergazdaként való bejelentkezéshez használt felhasználónév, ha van ilyen.
privateIpAddress

string

A virtuális gép magánhálózati IP-címe.
rdpAuthority

string

A port és a gazdagép neve pontosvesszővel elválasztva az RDP protokollon keresztül a virtuális géphez való csatlakozáshoz.
rdpInBrowserUrl

string

AZ RDP protokollon keresztül a böngészőben a virtuális géphez való csatlakozás URL-címe.
sshAuthority

string

A port és a gazdagép neve pontosvesszővel elválasztva az SSH-protokollon keresztül a virtuális géphez való csatlakozáshoz.
sshInBrowserUrl

string

Az SSH protokollon keresztül a böngészőben a virtuális géphez való csatlakozás URL-címe.

VirtualMachineState

Egy virtuális gép állapota.

Name Típus Description
Redeploying

string

A virtuális gép ismételt üzembe helyezése folyamatban van.
Reimaging

string

A virtuális gép újragondolása folyamatban van.
ResettingPassword

string

A virtuális gép jelszavának alaphelyzetbe állítása folyamatban van.
Running

string

A virtuális gép fut.
Starting

string

A virtuális gép elindul.
Stopped

string

A virtuális gép jelenleg le van állítva.
Stopping

string

A virtuális gép leáll.

VirtualMachineType

A tesztkörnyezet virtuális gépének típusa.

Name Típus Description
Template

string

Sablon virtuális gép
User

string

Felhasználói virtuális gép