Megosztás a következőn keresztül:


Virtual Machines - List

Virtuális gépek listázása egy adott tesztkörnyezetben.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI-paraméterek

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

string

A labor neve.

resourceGroupName
path True

string

Az erőforráscsoport neve.

subscriptionId
path True

string

Az előfizetés azonosítója.

api-version
query True

string

Ügyfél API-verziója.

$expand
query

string

Adja meg a $expand lekérdezést. Példa: "properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)"

$filter
query

string

A műveletre alkalmazandó szűrő. Példa: '$filter=contains(name;'myName')

$orderby
query

string

Az eredményekhez tartozó rendezési kifejezés OData-jelöléssel. Példa: "$orderby=name desc"

$top
query

integer

int32

A műveletből visszatérni kívánt erőforrások maximális száma. Példa: "$top=10"

Válaszok

Name Típus Description
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Biztonság

azure_auth

OAuth2 implicit támogatás

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation A Microsoft Azure elérése

Példák

VirtualMachines_List

Mintakérelem

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15

Mintaválasz

{
  "value": [
    {
      "properties": {
        "ownerObjectId": "",
        "ownerUserPrincipalName": "",
        "createdByUserId": "",
        "createdByUser": "",
        "createdDate": "2018-10-01T16:53:02.4830866-07:00",
        "computeId": "/subscriptions/{subscriptionId}/resourceGroups/{labName}-{vmName}-{randomSuffix}/providers/Microsoft.Compute/virtualMachines/{vmName}",
        "osType": "Linux",
        "size": "Standard_A2_v2",
        "userName": "{userName}",
        "labSubnetName": "{virtualNetworkName}Subnet",
        "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
        "disallowPublicIpAddress": true,
        "artifactDeploymentStatus": {
          "artifactsApplied": 0,
          "totalArtifacts": 0
        },
        "galleryImageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "16.04-LTS",
          "osType": "Linux",
          "version": "Latest"
        },
        "networkInterface": {},
        "allowClaim": true,
        "storageType": "Standard",
        "virtualMachineCreationSource": "FromGalleryImage",
        "dataDiskParameters": [],
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
      "name": "{vmName}",
      "type": "Microsoft.DevTestLab/labs/virtualMachines",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definíciók

Name Description
ApplicableSchedule

A virtuális gépekre vonatkozó ütemezések. Előfordulhat, hogy az ütemezések virtuális gépen vagy laborszinten vannak meghatározva.

ArtifactDeploymentStatusProperties

Az összetevők üzembe helyezésének tulajdonságai.

ArtifactInstallProperties

Egy összetevő tulajdonságai.

ArtifactParameterProperties

Egy összetevőparaméter tulajdonságai.

AttachNewDataDiskOptions

Tulajdonságok, amelyek új lemezt csatolnak a virtuális géphez.

CloudError

REST-kérésből származó hiba.

CloudErrorBody

EGY REST-kérésből származó hibatörzs.

ComputeDataDisk

Virtuális géphez csatlakoztatott adatlemezek.

ComputeVmInstanceViewStatus

Egy virtuális gép állapotadatai.

ComputeVmProperties

A Microsoft.Compute API által visszaadott virtuális gép tulajdonságai.

DataDiskProperties

Kérelemtörzs új vagy meglévő adatlemez virtuális géphez való hozzáadásához.

DayDetails

A napi ütemezés tulajdonságai.

EnableStatus

Az ütemezés állapota (például Engedélyezve, Letiltva)

GalleryImageReference

Egy Azure Marketplace kép referenciaadatai.

HostCachingOptions

Adatlemez gyorsítótárazási lehetősége (pl. Nincs, ReadOnly, ReadWrite).

HourDetails

Óránkénti ütemezés tulajdonságai.

InboundNatRule

A NAT szabálya – egy virtuális gép portjának (backendPort) a nyilvános IP-címen való felfedése terheléselosztóval.

LabVirtualMachine

Egy virtuális gép.

LabVirtualMachineList

Egy listaművelet válasza.

NetworkInterfaceProperties

A hálózati adapter tulajdonságai.

NotificationSettings

Az ütemezés értesítési beállításai.

Schedule

Egy ütemezés.

ScheduleCreationParameter

Ütemezés létrehozására szolgáló tulajdonságok.

SharedPublicIpAddressConfiguration

Egy virtuális gép tulajdonságai, amelyek meghatározzák, hogyan csatlakozik a terheléselosztóhoz.

StorageType

A lemez tárolási típusa (pl. Standard, Premium).

TransportProtocol

A végpont átviteli protokollja.

VirtualMachineCreationSource

A tesztkörnyezeti virtuális gép létrehozásának forrását jelzi. Csak kimeneti tulajdonság.

WeekDetails

Heti ütemezés tulajdonságai.

ApplicableSchedule

A virtuális gépekre vonatkozó ütemezések. Előfordulhat, hogy az ütemezések virtuális gépen vagy laborszinten vannak meghatározva.

Name Típus Description
id

string

Az erőforrás azonosítója.

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties.labVmsShutdown

Schedule

Az automatikus leállítás ütemezése, ha a tesztkörnyezet vagy a tesztkörnyezet erőforrásszintjén van beállítva.

properties.labVmsStartup

Schedule

Az automatikus indítás ütemezése, ha a tesztkörnyezet vagy a tesztkörnyezet erőforrásszintjén van beállítva.

tags

object

Az erőforrás címkéi.

type

string

Az erőforrás típusa.

ArtifactDeploymentStatusProperties

Az összetevők üzembe helyezésének tulajdonságai.

Name Típus Description
artifactsApplied

integer

A sikeresen alkalmazott összetevők teljes száma.

deploymentStatus

string

Az összetevő üzembehelyezési állapota.

totalArtifacts

integer

A feltételesen alkalmazott összetevők teljes száma.

ArtifactInstallProperties

Egy összetevő tulajdonságai.

Name Típus Description
artifactId

string

Az összetevő azonosítója.

artifactTitle

string

Az összetevő címe.

deploymentStatusMessage

string

Az üzembe helyezés állapotüzenete.

installTime

string

Az az időpont, amikor az összetevő elkezdi telepíteni a virtuális gépen.

parameters

ArtifactParameterProperties[]

Az összetevő paraméterei.

status

string

Az összetevő állapota.

vmExtensionStatusMessage

string

A virtuálisgép-bővítmény állapotüzenete.

ArtifactParameterProperties

Egy összetevőparaméter tulajdonságai.

Name Típus Description
name

string

Az összetevő paraméter neve.

value

string

Az összetevő paraméter értéke.

AttachNewDataDiskOptions

Tulajdonságok, amelyek új lemezt csatolnak a virtuális géphez.

Name Típus Description
diskName

string

A csatolni kívánt lemez neve.

diskSizeGiB

integer

A Gibibytes-ben csatolandó lemez mérete.

diskType

StorageType

A lemez tárolási típusa (pl. Standard, Premium).

CloudError

REST-kérésből származó hiba.

Name Típus Description
error

CloudErrorBody

A felhőben bekövetkezett hiba

CloudErrorBody

EGY REST-kérésből származó hibatörzs.

Name Típus Description
code

string

A hibakód.

details

CloudErrorBody[]

Belső hibák.

message

string

A hibaüzenet.

target

string

A hiba célja.

ComputeDataDisk

Virtuális géphez csatlakoztatott adatlemezek.

Name Típus Description
diskSizeGiB

integer

Lekéri az adatlemez méretét a GiB-ben.

diskUri

string

Egy blob által támogatott mögöttes blob URI-ja.

managedDiskId

string

Felügyelt lemez által készített biztonsági mentés esetén ez a számítási lemez erőforrásának azonosítója.

name

string

Lekéri az adatlemez nevét.

ComputeVmInstanceViewStatus

Egy virtuális gép állapotadatai.

Name Típus Description
code

string

Lekéri az állapotkódot.

displayStatus

string

Lekéri az állapot rövid honosítható címkéjét.

message

string

Lekéri az állapothoz társított üzenetet.

ComputeVmProperties

A Microsoft.Compute API által visszaadott virtuális gép tulajdonságai.

Name Típus Description
dataDiskIds

string[]

Lekéri a virtuális gép adatlemezeinek blob-URI-ját.

dataDisks

ComputeDataDisk[]

Lekéri a virtuális géphez csatolt összes adatlemezt.

networkInterfaceId

string

Lekéri a virtuális gép hálózati adapterének azonosítóját.

osDiskId

string

Lekéri az operációsrendszer-lemez blobjának URI-ját a virtuális géphez.

osType

string

Lekéri a virtuális gép operációs rendszerének típusát.

statuses

ComputeVmInstanceViewStatus[]

Lekéri a virtuális gép állapotát.

vmSize

string

Lekéri a virtuális gép méretét.

DataDiskProperties

Kérelemtörzs új vagy meglévő adatlemez virtuális géphez való hozzáadásához.

Name Típus Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

Megadja az új lemez virtuális géphez való csatolásának beállításait.

existingLabDiskId

string

Megadja a virtuális géphez csatolandó meglévő tesztkörnyezetlemez-azonosítót.

hostCaching

HostCachingOptions

Adatlemez gyorsítótárazási lehetősége (pl. Nincs, ReadOnly, ReadWrite).

DayDetails

A napi ütemezés tulajdonságai.

Name Típus Description
time

string

Az ütemezés napjának időpontja.

EnableStatus

Az ütemezés állapota (például Engedélyezve, Letiltva)

Name Típus Description
Disabled

string

Enabled

string

GalleryImageReference

Egy Azure Marketplace kép referenciaadatai.

Name Típus Description
offer

string

A katalógus képének ajánlata.

osType

string

A katalógus rendszerképének operációsrendszer-típusa.

publisher

string

A katalóguskép közzétevője.

sku

string

A katalógus képének termékváltozata.

version

string

A katalógus képének verziója.

HostCachingOptions

Adatlemez gyorsítótárazási lehetősége (pl. Nincs, ReadOnly, ReadWrite).

Name Típus Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Óránkénti ütemezés tulajdonságai.

Name Típus Description
minute

integer

Az ütemezés futásának percei.

InboundNatRule

A NAT szabálya – egy virtuális gép portjának (backendPort) a nyilvános IP-címen való felfedése terheléselosztóval.

Name Típus Description
backendPort

integer

Az a port, amelyre a külső forgalmat átirányítja a rendszer.

frontendPort

integer

A bejövő kapcsolat külső végpontportja. A lehetséges értékek 1 és 65535 között mozognak, beleértve a értéket is. Ha nincs meghatározva, a rendszer automatikusan lefoglal egy értéket.

transportProtocol

TransportProtocol

A végpont átviteli protokollja.

LabVirtualMachine

Egy virtuális gép.

Name Típus Alapértelmezett érték Description
id

string

Az erőforrás azonosítója.

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties.allowClaim

boolean

False

Azt jelzi, hogy egy másik felhasználó átveheti-e a virtuális gép tulajdonjogát

properties.applicableSchedule

ApplicableSchedule

A virtuális gép vonatkozó ütemezése.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

A virtuális gép összetevő üzembehelyezési állapota.

properties.artifacts

ArtifactInstallProperties[]

A virtuális gépre telepítendő összetevők.

properties.computeId

string

A virtuális gép erőforrás-azonosítója (Microsoft.Compute).

properties.computeVm

ComputeVmProperties

A számítási virtuális gép tulajdonságai.

properties.createdByUser

string

A virtuális gép létrehozójának e-mail-címe.

properties.createdByUserId

string

A virtuális gép létrehozójának objektumazonosítója.

properties.createdDate

string

A virtuális gép létrehozási dátuma.

properties.customImageId

string

A virtuális gép egyéni rendszerkép-azonosítója.

properties.dataDiskParameters

DataDiskProperties[]

A virtuális géphez a létrehozás után csatolandó új vagy meglévő adatlemezek

properties.disallowPublicIpAddress

boolean

False

Azt jelzi, hogy a virtuális gépet nyilvános IP-cím nélkül kell-e létrehozni.

properties.environmentId

string

A virtuális gépet tartalmazó környezet erőforrás-azonosítója, ha van ilyen.

properties.expirationDate

string

A virtuális gép lejárati dátuma.

properties.fqdn

string

A virtuális gép teljes tartományneve.

properties.galleryImageReference

GalleryImageReference

A Microsoft Azure Marketplace virtuális gép képhivatkozása.

properties.isAuthenticationWithSshKey

boolean

Azt jelzi, hogy ez a virtuális gép használ-e SSH-kulcsot a hitelesítéshez.

properties.labSubnetName

string

A virtuális gép tesztkörnyezeti alhálózatának neve.

properties.labVirtualNetworkId

string

A virtuális gép tesztkörnyezeti virtuális hálózati azonosítója.

properties.lastKnownPowerState

string

Utolsó ismert számítási teljesítményállapot rögzítve a DTL-ben

properties.networkInterface

NetworkInterfaceProperties

A hálózati adapter tulajdonságai.

properties.notes

string

A virtuális gép megjegyzései.

properties.osType

string

A virtuális gép operációs rendszerének típusa.

properties.ownerObjectId

string

dynamicValue

A virtuális gép tulajdonosának objektumazonosítója.

properties.ownerUserPrincipalName

string

A virtuális gép tulajdonosának egyszerű felhasználóneve.

properties.password

string

A virtuális gép rendszergazdájának jelszava.

properties.planId

string

A virtuálisgép-rendszerképhez társított csomag azonosítója

properties.provisioningState

string

Az erőforrás kiépítési állapota.

properties.scheduleParameters

ScheduleCreationParameter[]

Létrehozandó virtuálisgép-ütemezések

properties.size

string

A virtuális gép mérete.

properties.sshKey

string

A virtuálisgép-rendszergazda SSH-kulcsa.

properties.storageType

string

labStorageType

A virtuális géphez használandó tárolótípus (pl. Standard, Premium).

properties.uniqueIdentifier

string

Az erőforrás egyedi nem módosítható azonosítója (GUID).

properties.userName

string

A virtuális gép felhasználóneve.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

A tesztkörnyezeti virtuális gép létrehozásának forrását jelzi. Csak kimeneti tulajdonság.

tags

object

Az erőforrás címkéi.

type

string

Az erőforrás típusa.

LabVirtualMachineList

Egy listaművelet válasza.

Name Típus Description
nextLink

string

A következő találatok hivatkozása.

value

LabVirtualMachine[]

A listaművelet eredményei.

NetworkInterfaceProperties

A hálózati adapter tulajdonságai.

Name Típus Description
dnsName

string

A DNS neve.

privateIpAddress

string

A magánhálózati IP-cím.

publicIpAddress

string

A nyilvános IP-cím.

publicIpAddressId

string

A nyilvános IP-cím erőforrás-azonosítója.

rdpAuthority

string

Az RdpAuthority tulajdonság egy kiszolgáló DNS-állomásneve vagy IP-címe, amelyet az RDP (Távoli asztali protokoll) szolgáltatásportszáma követ.

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

A nyilvános IP-címek több virtuális gépen való megosztásának konfigurációja.

sshAuthority

string

Az SshAuthority tulajdonság egy kiszolgáló DNS-állomásneve vagy IP-címe, amelyet az SSH szolgáltatásport-száma követ.

subnetId

string

Az alhálózat erőforrás-azonosítója.

virtualNetworkId

string

A virtuális hálózat erőforrás-azonosítója.

NotificationSettings

Az ütemezés értesítési beállításai.

Name Típus Alapértelmezett érték Description
emailRecipient

string

Az e-mail címzettje, akinek értesítéseket szeretne küldeni (a pontosvesszővel elválasztott e-mail-címek listája lehet).

notificationLocale

string

Az értesítés küldésekor használni kívánt területi beállítás (a nem támogatott nyelvekre vonatkozó tartalék az EN).

status

EnableStatus

Disabled

Ha az értesítések engedélyezve vannak ehhez az ütemezéshez (például Engedélyezve, Letiltva).

timeInMinutes

integer

Az értesítés elküldésének időpontja percekben.

webhookUrl

string

Az a webhook URL-címe, amelyre az értesítés el lesz küldve.

Schedule

Egy ütemezés.

Name Típus Alapértelmezett érték Description
id

string

Az erőforrás azonosítója.

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties.createdDate

string

Az ütemezés létrehozási dátuma.

properties.dailyRecurrence

DayDetails

Ha az ütemezés a hét minden napján egyszer történik, adja meg a napi ismétlődés értékét.

properties.hourlyRecurrence

HourDetails

Ha az ütemezés naponta többször is megtörténik, adja meg az óránkénti ismétlődéseket.

properties.notificationSettings

NotificationSettings

Értesítési beállítások.

properties.provisioningState

string

Az erőforrás kiépítési állapota.

properties.status

EnableStatus

Disabled

Az ütemezés állapota (például Engedélyezve, Letiltva)

properties.targetResourceId

string

Az erőforrás-azonosító, amelyhez az ütemezés tartozik

properties.taskType

string

Az ütemezés tevékenységtípusa (pl. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Az időzóna azonosítója (pl. kínai téli idő, grönlandi téli idő, csendes-óceáni téli idő stb.). A tulajdonság lehetséges értékei a következő helyen találhatók: IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Egy erőforrás egyedi nem módosítható azonosítója (GUID).

properties.weeklyRecurrence

WeekDetails

Ha az ütemezés csak a hét egyes napjaiban fordul elő, adja meg a heti ismétlődéseket.

tags

object

Az erőforrás címkéi.

type

string

Az erőforrás típusa.

ScheduleCreationParameter

Ütemezés létrehozására szolgáló tulajdonságok.

Name Típus Alapértelmezett érték Description
location

string

Az új virtuális gép vagy környezet helye

name

string

A virtuális gép vagy környezet neve

properties.dailyRecurrence

DayDetails

Ha az ütemezés a hét minden napján egyszer történik, adja meg a napi ismétlődés értékét.

properties.hourlyRecurrence

HourDetails

Ha az ütemezés naponta többször is megtörténik, adja meg az óránkénti ismétlődéseket.

properties.notificationSettings

NotificationSettings

Értesítési beállítások.

properties.status

EnableStatus

Disabled

Az ütemezés állapota (például Engedélyezve, Letiltva)

properties.targetResourceId

string

Az erőforrás-azonosító, amelyhez az ütemezés tartozik

properties.taskType

string

Az ütemezés tevékenységtípusa (pl. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Az időzóna azonosítója (pl. kínai téli idő, grönlandi téli idő, csendes-óceáni téli idő stb.). A tulajdonság lehetséges értékei a következő helyen találhatók: IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Ha az ütemezés csak a hét egyes napjaiban fordul elő, adja meg a heti ismétlődéseket.

tags

object

Az erőforrás címkéi.

SharedPublicIpAddressConfiguration

Egy virtuális gép tulajdonságai, amelyek meghatározzák, hogyan csatlakozik a terheléselosztóhoz.

Name Típus Description
inboundNatRules

InboundNatRule[]

A bejövő NAT-szabályok

StorageType

A lemez tárolási típusa (pl. Standard, Premium).

Name Típus Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

A végpont átviteli protokollja.

Name Típus Description
Tcp

string

Udp

string

VirtualMachineCreationSource

A tesztkörnyezeti virtuális gép létrehozásának forrását jelzi. Csak kimeneti tulajdonság.

Name Típus Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Heti ütemezés tulajdonságai.

Name Típus Description
time

string

Az ütemezés napjának időpontja.

weekdays

string[]

A hét azon napjai, amelyekre az ütemezés be van állítva (például vasárnap, hétfő, kedd stb.).