Dela via


Virtual Machines - List

Lista virtuella datorer i ett visst labb.

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-parametrar

Name I Obligatorisk Typ Description
labName
path True

string

Namnet på labbet.

resourceGroupName
path True

string

Namnet på resursgruppen.

subscriptionId
path True

string

Prenumerations-ID: t.

api-version
query True

string

Klient-API-version.

$expand
query

string

Ange frågan $expand. Exempel: "properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)"

$filter
query

string

Filtret som ska tillämpas på åtgärden. Exempel: '$filter=contains(name,'myName')

$orderby
query

string

Orderuttrycket för resultaten med OData-notation. Exempel: "$orderby=name desc"

$top
query

integer

int32

Det maximala antalet resurser som ska returneras från åtgärden. Exempel: "$top=10"

Svar

Name Typ Description
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Säkerhet

azure_auth

Implicit beviljande av OAuth2

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Få åtkomst till Microsoft Azure

Exempel

VirtualMachines_List

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ApplicableSchedule

Scheman som gäller för en virtuell dator. Scheman kan ha definierats på en virtuell dator eller på labbnivå.

ArtifactDeploymentStatusProperties

Egenskaper för en artefaktdistribution.

ArtifactInstallProperties

Egenskaper för en artefakt.

ArtifactParameterProperties

Egenskaper för en artefaktparameter.

AttachNewDataDiskOptions

Egenskaper för att ansluta en ny disk till den virtuella datorn.

CloudError

Fel från en REST-begäran.

CloudErrorBody

Brödtext för ett fel från en REST-begäran.

ComputeDataDisk

En datadisk som är ansluten till en virtuell dator.

ComputeVmInstanceViewStatus

Statusinformation om en virtuell dator.

ComputeVmProperties

Egenskaper för en virtuell dator som returneras av API:et Microsoft.Compute.

DataDiskProperties

Begärandetext för att lägga till en ny eller befintlig datadisk till en virtuell dator.

DayDetails

Egenskaper för ett dagligt schema.

EnableStatus

Status för schemat (t.ex. Aktiverad, Inaktiverad)

GalleryImageReference

Referensinformationen för en Azure Marketplace bild.

HostCachingOptions

Cachelagringsalternativ för en datadisk (t.ex. Ingen, ReadOnly, ReadWrite).

HourDetails

Egenskaper för ett schema per timme.

InboundNatRule

En regel för NAT – exponera en virtuell dators port (backendPort) på den offentliga IP-adressen med hjälp av en lastbalanserare.

LabVirtualMachine

En virtuell dator.

LabVirtualMachineList

Svaret för en liståtgärd.

NetworkInterfaceProperties

Egenskaper för ett nätverksgränssnitt.

NotificationSettings

Meddelandeinställningar för ett schema.

Schedule

Ett schema.

ScheduleCreationParameter

Egenskaper för att skapa ett schema.

SharedPublicIpAddressConfiguration

Egenskaper för en virtuell dator som avgör hur den är ansluten till en lastbalanserare.

StorageType

Lagringstypen för disken (t.ex. Standard, Premium).

TransportProtocol

Transportprotokollet för slutpunkten.

VirtualMachineCreationSource

Meddelar källan för skapandet av den virtuella labbdatorn. Endast utdataegenskap.

WeekDetails

Egenskaper för ett veckoschema.

ApplicableSchedule

Scheman som gäller för en virtuell dator. Scheman kan ha definierats på en virtuell dator eller på labbnivå.

Name Typ Description
id

string

Resursens identifierare.

location

string

Platsen för resursen.

name

string

Namnet på resursen.

properties.labVmsShutdown

Schedule

Schemat för automatisk avstängning, om ett har angetts på labb- eller labbresursnivå.

properties.labVmsStartup

Schedule

Schemat för automatisk start, om ett har angetts på labb- eller labbresursnivå.

tags

object

Taggarna för resursen.

type

string

Resurstypen.

ArtifactDeploymentStatusProperties

Egenskaper för en artefaktdistribution.

Name Typ Description
artifactsApplied

integer

Det totala antalet artefakter som har tillämpats.

deploymentStatus

string

Distributionsstatus för artefakten.

totalArtifacts

integer

Det totala antalet artefakter som tillämpades preliminärt.

ArtifactInstallProperties

Egenskaper för en artefakt.

Name Typ Description
artifactId

string

Artefaktens identifierare.

artifactTitle

string

Artefaktens rubrik.

deploymentStatusMessage

string

Statusmeddelandet från distributionen.

installTime

string

Den tid då artefakten börjar installeras på den virtuella datorn.

parameters

ArtifactParameterProperties[]

Parametrarna för artefakten.

status

string

Artefaktens status.

vmExtensionStatusMessage

string

Statusmeddelandet från tillägget för den virtuella datorn.

ArtifactParameterProperties

Egenskaper för en artefaktparameter.

Name Typ Description
name

string

Namnet på artefaktparametern.

value

string

Värdet för artefaktparametern.

AttachNewDataDiskOptions

Egenskaper för att ansluta en ny disk till den virtuella datorn.

Name Typ Description
diskName

string

Namnet på den disk som ska anslutas.

diskSizeGiB

integer

Storleken på disken som ska anslutas i Gibibytes.

diskType

StorageType

Lagringstypen för disken (t.ex. Standard, Premium).

CloudError

Fel från en REST-begäran.

Name Typ Description
error

CloudErrorBody

Molnfelet som inträffade

CloudErrorBody

Brödtext för ett fel från en REST-begäran.

Name Typ Description
code

string

Felkoden.

details

CloudErrorBody[]

Inre fel.

message

string

Felmeddelandet.

target

string

Felmålet.

ComputeDataDisk

En datadisk som är ansluten till en virtuell dator.

Name Typ Description
diskSizeGiB

integer

Hämtar datadiskens storlek i GiB.

diskUri

string

När den backas upp av en blob, URI för den underliggande bloben.

managedDiskId

string

När den backas upp av en hanterad disk är detta ID:t för beräkningsdiskresursen.

name

string

Hämtar datadiskens namn.

ComputeVmInstanceViewStatus

Statusinformation om en virtuell dator.

Name Typ Description
code

string

Hämtar statuskoden.

displayStatus

string

Hämtar den korta localizable-etiketten för statusen.

message

string

Hämtar meddelandet som är associerat med statusen.

ComputeVmProperties

Egenskaper för en virtuell dator som returneras av API:et Microsoft.Compute.

Name Typ Description
dataDiskIds

string[]

Hämtar blob-URI för datadiskar för den virtuella datorn.

dataDisks

ComputeDataDisk[]

Hämtar alla datadiskar som är anslutna till den virtuella datorn.

networkInterfaceId

string

Hämtar nätverksgränssnitts-ID för den virtuella datorn.

osDiskId

string

Hämtar OS-diskblob-URI för den virtuella datorn.

osType

string

Hämtar operativsystemtypen för den virtuella datorn.

statuses

ComputeVmInstanceViewStatus[]

Hämtar status för den virtuella datorn.

vmSize

string

Hämtar storleken på den virtuella datorn.

DataDiskProperties

Begärandetext för att lägga till en ny eller befintlig datadisk till en virtuell dator.

Name Typ Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

Anger alternativ för att ansluta en ny disk till den virtuella datorn.

existingLabDiskId

string

Anger det befintliga labbdisk-ID:t som ska anslutas till den virtuella datorn.

hostCaching

HostCachingOptions

Cachelagringsalternativ för en datadisk (t.ex. Ingen, ReadOnly, ReadWrite).

DayDetails

Egenskaper för ett dagligt schema.

Name Typ Description
time

string

Den tid på dagen som schemat inträffar.

EnableStatus

Status för schemat (t.ex. Aktiverad, Inaktiverad)

Name Typ Description
Disabled

string

Enabled

string

GalleryImageReference

Referensinformationen för en Azure Marketplace bild.

Name Typ Description
offer

string

Galleribildens erbjudande.

osType

string

Galleriavbildningens operativsystemtyp.

publisher

string

Utgivaren av galleribilden.

sku

string

SKU:n för galleribilden.

version

string

Versionen av galleribilden.

HostCachingOptions

Cachelagringsalternativ för en datadisk (t.ex. Ingen, ReadOnly, ReadWrite).

Name Typ Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Egenskaper för ett schema per timme.

Name Typ Description
minute

integer

Minuter av timmen som schemat körs.

InboundNatRule

En regel för NAT – exponera en virtuell dators port (backendPort) på den offentliga IP-adressen med hjälp av en lastbalanserare.

Name Typ Description
backendPort

integer

Porten som den externa trafiken ska omdirigeras till.

frontendPort

integer

Den externa slutpunktsporten för den inkommande anslutningen. Möjliga värden mellan 1 och 65535, inklusive. Om det inte anges allokeras ett värde automatiskt.

transportProtocol

TransportProtocol

Transportprotokollet för slutpunkten.

LabVirtualMachine

En virtuell dator.

Name Typ Standardvärde Description
id

string

Resursens identifierare.

location

string

Platsen för resursen.

name

string

Namnet på resursen.

properties.allowClaim

boolean

False

Anger om en annan användare kan bli ägare till den virtuella datorn

properties.applicableSchedule

ApplicableSchedule

Tillämpligt schema för den virtuella datorn.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

Distributionsstatus för artefakt för den virtuella datorn.

properties.artifacts

ArtifactInstallProperties[]

Artefakterna som ska installeras på den virtuella datorn.

properties.computeId

string

Resursidentifieraren (Microsoft.Compute) för den virtuella datorn.

properties.computeVm

ComputeVmProperties

Egenskaperna för den virtuella beräkningsdatorn.

properties.createdByUser

string

E-postadressen till skaparen av den virtuella datorn.

properties.createdByUserId

string

Objektidentifieraren för den virtuella datorns skapare.

properties.createdDate

string

Skapandedatumet för den virtuella datorn.

properties.customImageId

string

Den virtuella datorns anpassade avbildningsidentifierare.

properties.dataDiskParameters

DataDiskProperties[]

Nya eller befintliga datadiskar som ska anslutas till den virtuella datorn när de har skapats

properties.disallowPublicIpAddress

boolean

False

Anger om den virtuella datorn ska skapas utan en offentlig IP-adress.

properties.environmentId

string

Resurs-ID för miljön som innehåller den här virtuella datorn, om sådan finns.

properties.expirationDate

string

Förfallodatum för den virtuella datorn.

properties.fqdn

string

Det fullständigt kvalificerade domännamnet för den virtuella datorn.

properties.galleryImageReference

GalleryImageReference

Microsoft Azure Marketplace avbildningsreferens för den virtuella datorn.

properties.isAuthenticationWithSshKey

boolean

Anger om den här virtuella datorn använder en SSH-nyckel för autentisering.

properties.labSubnetName

string

Namnet på den virtuella datorns labbundernät.

properties.labVirtualNetworkId

string

Labb-ID för det virtuella nätverket för den virtuella datorn.

properties.lastKnownPowerState

string

Senast kända beräkningskrafttillstånd som registrerats i DTL

properties.networkInterface

NetworkInterfaceProperties

Egenskaperna för nätverksgränssnittet.

properties.notes

string

Anteckningarna för den virtuella datorn.

properties.osType

string

Den virtuella datorns operativsystemtyp.

properties.ownerObjectId

string

dynamicValue

Objektidentifieraren för den virtuella datorns ägare.

properties.ownerUserPrincipalName

string

Användarens huvudnamn för den virtuella datorns ägare.

properties.password

string

Lösenordet för den virtuella datoradministratören.

properties.planId

string

ID:t för planen som är associerad med avbildningen av den virtuella datorn

properties.provisioningState

string

Resursens etableringsstatus.

properties.scheduleParameters

ScheduleCreationParameter[]

Scheman för virtuella datorer som ska skapas

properties.size

string

Storleken på den virtuella datorn.

properties.sshKey

string

SSH-nyckeln för den virtuella datoradministratören.

properties.storageType

string

labStorageType

Lagringstyp som ska användas för virtuella datorer (t.ex. Standard, Premium).

properties.uniqueIdentifier

string

Den unika oföränderliga identifieraren för en resurs (GUID).

properties.userName

string

Användarnamnet för den virtuella datorn.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Meddelar källan för skapandet av den virtuella labbdatorn. Endast utdataegenskap.

tags

object

Taggarna för resursen.

type

string

Resurstypen.

LabVirtualMachineList

Svaret för en liståtgärd.

Name Typ Description
nextLink

string

Länk för nästa uppsättning resultat.

value

LabVirtualMachine[]

Resultat av liståtgärden.

NetworkInterfaceProperties

Egenskaper för ett nätverksgränssnitt.

Name Typ Description
dnsName

string

DNS-namnet.

privateIpAddress

string

Den privata IP-adressen.

publicIpAddress

string

Den offentliga IP-adressen.

publicIpAddressId

string

Resurs-ID för den offentliga IP-adressen.

rdpAuthority

string

Egenskapen RdpAuthority är ett DNS-värdnamn eller IP-adress för servern följt av tjänstportnumret för RDP (Remote Desktop Protocol).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Konfigurationen för att dela en offentlig IP-adress mellan flera virtuella datorer.

sshAuthority

string

Egenskapen SshAuthority är ett DNS-värdnamn eller IP-adress för servern följt av tjänstportnumret för SSH.

subnetId

string

Resurs-ID för undernätet.

virtualNetworkId

string

Resurs-ID för det virtuella nätverket.

NotificationSettings

Meddelandeinställningar för ett schema.

Name Typ Standardvärde Description
emailRecipient

string

E-postmottagaren att skicka meddelanden till (kan vara en lista med semikolonavgränsade e-postadresser).

notificationLocale

string

Språkvarianten som ska användas när du skickar ett meddelande (återställning för språk som inte stöds är EN).

status

EnableStatus

Disabled

Om meddelanden är aktiverade för det här schemat (t.ex. aktiverat, inaktiverat).

timeInMinutes

integer

Tid i minuter innan händelsen då meddelandet skickas.

webhookUrl

string

Den webhook-URL som meddelandet ska skickas till.

Schedule

Ett schema.

Name Typ Standardvärde Description
id

string

Resursens identifierare.

location

string

Platsen för resursen.

name

string

Namnet på resursen.

properties.createdDate

string

Datumet då schemat skapades.

properties.dailyRecurrence

DayDetails

Om schemat ska ske en gång varje dag i veckan anger du den dagliga upprepningen.

properties.hourlyRecurrence

HourDetails

Om schemat ska ske flera gånger om dagen anger du upprepningen varje timme.

properties.notificationSettings

NotificationSettings

Meddelandeinställningar.

properties.provisioningState

string

Resursens etableringsstatus.

properties.status

EnableStatus

Disabled

Status för schemat (t.ex. Aktiverad, Inaktiverad)

properties.targetResourceId

string

Det resurs-ID som schemat tillhör

properties.taskType

string

Uppgiftstypen för schemat (t.ex. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Tidszons-ID (t.ex. China Standard Time, Grönland Standard Time, Pacific Standard Time osv.). Möjliga värden för den här egenskapen finns i IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Den unika oföränderliga identifieraren för en resurs (GUID).

properties.weeklyRecurrence

WeekDetails

Om schemat bara inträffar några dagar i veckan anger du veckovis upprepning.

tags

object

Taggarna för resursen.

type

string

Resurstypen.

ScheduleCreationParameter

Egenskaper för att skapa ett schema.

Name Typ Standardvärde Description
location

string

Platsen för den nya virtuella datorn eller miljön

name

string

Namnet på den virtuella datorn eller miljön

properties.dailyRecurrence

DayDetails

Om schemat ska ske en gång varje dag i veckan anger du den dagliga upprepningen.

properties.hourlyRecurrence

HourDetails

Om schemat ska ske flera gånger om dagen anger du upprepningen varje timme.

properties.notificationSettings

NotificationSettings

Meddelandeinställningar.

properties.status

EnableStatus

Disabled

Status för schemat (t.ex. Aktiverad, Inaktiverad)

properties.targetResourceId

string

Det resurs-ID som schemat tillhör

properties.taskType

string

Uppgiftstypen för schemat (t.ex. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

Tidszons-ID (t.ex. China Standard Time, Grönland Standard Time, Pacific Standard Time osv.). Möjliga värden för den här egenskapen finns i IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Om schemat bara inträffar några dagar i veckan anger du veckovis upprepning.

tags

object

Taggarna för resursen.

SharedPublicIpAddressConfiguration

Egenskaper för en virtuell dator som avgör hur den är ansluten till en lastbalanserare.

Name Typ Description
inboundNatRules

InboundNatRule[]

Inkommande NAT-regler

StorageType

Lagringstypen för disken (t.ex. Standard, Premium).

Name Typ Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Transportprotokollet för slutpunkten.

Name Typ Description
Tcp

string

Udp

string

VirtualMachineCreationSource

Meddelar källan för skapandet av den virtuella labbdatorn. Endast utdataegenskap.

Name Typ Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Egenskaper för ett veckoschema.

Name Typ Description
time

string

Den tid på dagen som schemat inträffar.

weekdays

string[]

Veckodagarna som schemat anges för (t.ex. söndag, måndag, tisdag osv.).