Virtual Machines - Get

Virtuális gép lekérése.

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

URI-paraméterek

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

string

A labor neve.

name
path True

string

A virtuális gép neve.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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

subscriptionId
path True

string

minLength: 1

A cél-előfizetés azonosítója.

api-version
query True

string

minLength: 1

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

$expand
query

string

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

Válaszok

Name Típus Description
200 OK

LabVirtualMachine

Az Azure-művelet sikeresen befejeződött.

Other Status Codes

ErrorResponse

Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

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 felhasználói fiók megszemélyesítése

Példák

VirtualMachines_Get

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
ApplicableSchedule

A virtuális gépekre vonatkozó ütemezések. Előfordulhat, hogy az ütemezéseket virtuális gépen vagy laborszinten határozták meg.

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.

ComputeDataDisk

Virtuális géphez csatlakoztatott adatlemezek.

ComputeVmInstanceViewStatus

Állapotinformációk egy virtuális gépről.

ComputeVmProperties

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

createdByType

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

DataDiskProperties

Új vagy meglévő adatlemez virtuális géphez való hozzáadására vonatkozó kérelem törzse.

DayDetails

A napi ütemezés tulajdonságai.

EnableStatus

Azt jelzi, hogy az összetevő forrása engedélyezve van-e (értékek: Engedélyezve, Letiltva).

ErrorAdditionalInfo

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

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

GalleryImageReference

Az Azure Marketplace-rendszerképek referenciaadatai.

HostCachingOptions

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

HourDetails

Az órarend tulajdonságai.

InboundNatRule

A NAT egyik 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.

NetworkInterfaceProperties

A hálózati adapter tulajdonságai.

NotificationSettings

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

Schedule

Egy ütemterv.

ScheduleCreationParameter

Ütemezés létrehozásához szükséges 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).

systemData

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

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éseket virtuális gépen vagy laborszinten határozták meg.

Name Típus Description
id

string

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

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 labor erőforrásszintjén van beállítva.

properties.labVmsStartup

Schedule

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

systemData

systemData

A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.

tags

object

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

type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ArtifactDeploymentStatusProperties

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

Name Típus Description
artifactsApplied

integer (int32)

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

deploymentStatus

string

Az összetevő üzembehelyezési állapota.

totalArtifacts

integer (int32)

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 (date-time)

Az az idő, 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 csatolandó lemez neve.

diskSizeGiB

integer (int32)

A Gibibytes-ben csatolandó lemez mérete.

diskType

StorageType

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

ComputeDataDisk

Virtuális géphez csatlakoztatott adatlemezek.

Name Típus Description
diskSizeGiB

integer (int32)

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

diskUri

string

Ha egy blob végzi a háttérrendszert, a 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

Állapotinformációk egy virtuális gépről.

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 az adatlemezek blob uri-ját a virtuális géphez.

dataDisks

ComputeDataDisk[]

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

networkInterfaceId

string

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

osDiskId

string

Lekéri az operációsrendszer-lemez blob 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.

createdByType

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

Érték Description
User
Application
ManagedIdentity
Key

DataDiskProperties

Új vagy meglévő adatlemez virtuális géphez való hozzáadására vonatkozó kérelem törzse.

Name Típus Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

Megadja az új lemez virtuális géphez való csatolásának lehetőségeit.

existingLabDiskId

string

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

hostCaching

HostCachingOptions

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

DayDetails

A napi ütemezés tulajdonságai.

Name Típus Description
time

string

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

EnableStatus

Azt jelzi, hogy az összetevő forrása engedélyezve van-e (értékek: Engedélyezve, Letiltva).

Érték Description
Enabled
Disabled

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.

GalleryImageReference

Az Azure Marketplace-rendszerképek referenciaadatai.

Name Típus Description
offer

string

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

osType

string

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

publisher

string

A katalógus képének 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 (például Nincs, ReadOnly, ReadWrite).

Érték Description
None
ReadOnly
ReadWrite

HourDetails

Az órarend tulajdonságai.

Name Típus Description
minute

integer (int32)

Az ütemezés percei.

InboundNatRule

A NAT egyik 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 (int32)

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

frontendPort

integer (int32)

A bejövő kapcsolat külső végpontportja. A lehetséges értékek az 1 és 65535 közötti tartományba esnek, beleértve a szélső értékeket 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 teljes erőforrás-azonosítója. Example - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Az a földrajzi hely, ahol az erőforrás él

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épre vonatkozó ütemezés.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

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

properties.artifacts

ArtifactInstallProperties[]

A virtuális gépre telepíteni kívánt ö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 (date-time)

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

properties.customImageId

string

A virtuális gép egyéni képazonosítója.

properties.dataDiskParameters

DataDiskProperties[]

Új vagy meglévő adatlemezek csatolása a virtuális géphez a létrehozás után

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 (date-time)

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

properties.fqdn

string

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

properties.galleryImageReference

GalleryImageReference

A virtuális gép Microsoft Azure Marketplace-rendszerképének referenciája.

properties.isAuthenticationWithSshKey

boolean

Azt jelzi, hogy ez a virtuális gép SSH-kulcsot használ-e 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 jegyzetei.

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ális gép lemezképéhez társított terv azonosítója

properties.provisioningState

string

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

properties.scheduleParameters

ScheduleCreationParameter[]

A virtuális gép létrehozandó ütemezései

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ási 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.

systemData

systemData

A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.

tags

object

Erőforráscímkék.

type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

NetworkInterfaceProperties

A hálózati adapter tulajdonságai.

Name Típus Description
dnsName

string

A DNS neve.

privateIpAddress

string

A privát 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ásport-szá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

Ü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álandó 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 (azaz engedélyezve, letiltva).

timeInMinutes

integer (int32)

Az értesítés elküldésének időpontja percekben az esemény előtt.

webhookUrl

string

A webhook URL-címe, amelyre az értesítést küldi.

Schedule

Egy ütemterv.

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

string

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

location

string

Az a földrajzi hely, ahol az erőforrás él

name

string

Az erőforrás neve

properties.createdDate

string (date-time)

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

properties.dailyRecurrence

DayDetails

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

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 (azaz 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 IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Az 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.

systemData

systemData

A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.

tags

object

Erőforráscímkék.

type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ScheduleCreationParameter

Ütemezés létrehozásához szükséges 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 megtörténik, adja meg a napi ismétlődéseket.

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 (azaz 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 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).

Érték Description
Standard
Premium
StandardSSD

systemData

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

Name Típus Description
createdAt

string (date-time)

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 (date-time)

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

TransportProtocol

A végpont átviteli protokollja.

Érték Description
Tcp
Udp

VirtualMachineCreationSource

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

Érték Description
FromCustomImage
FromGalleryImage
FromSharedGalleryImage

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.).